diff --git a/docs/latest/client-download.html b/docs/latest/client-download.html index df08451cb..e2661d8a3 100644 --- a/docs/latest/client-download.html +++ b/docs/latest/client-download.html @@ -1,7 +1,7 @@ - + Main Page 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 19a62e491..8da21b2f2 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 @@ -UC_ADMIN_DISABLES_SCHEDULER_JOB_PROCESSINGadministrationnotificationschedule0executedREQUEST_SCHEDULER_DISABLE_JOB_PROCESSING1SCHEDULER_JOB_PROCESSING_DISABLEDSCHEDULER_JOB_PROCESSING_DISABLED \ No newline at end of file +UC_ADMIN_DISABLES_SCHEDULER_JOB_PROCESSINGadministrationnotificationschedule0executedREQUEST_SCHEDULER_DISABLE_JOB_PROCESSING1SCHEDULER_JOB_PROCESSING_DISABLEDSCHEDULER_JOB_PROCESSING_DISABLED \ 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 104018dda..eae359746 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 @@ -UC_ADMIN_ENABLES_SCHEDULER_JOB_PROCESSINGadministrationnotificationschedule0executedREQUEST_SCHEDULER_ENABLE_JOB_PROCESSING1SCHEDULER_JOB_PROCESSING_ENABLEDSCHEDULER_JOB_PROCESSING_ENABLED \ No newline at end of file +UC_ADMIN_ENABLES_SCHEDULER_JOB_PROCESSINGadministrationnotificationschedule0executedREQUEST_SCHEDULER_ENABLE_JOB_PROCESSING1SCHEDULER_JOB_PROCESSING_ENABLEDSCHEDULER_JOB_PROCESSING_ENABLED \ No newline at end of file diff --git a/docs/latest/sechub-architecture.html b/docs/latest/sechub-architecture.html index 36bd4490e..a8e829c82 100644 --- a/docs/latest/sechub-architecture.html +++ b/docs/latest/sechub-architecture.html @@ -531,7 +531,7 @@ @@ -7230,6 +7235,66 @@

7.5.81. UC_080-System resumes suspended jobs

+
+

7.5.82. UC_081-get assigned project data

+
+

User, Owner or Admin fetches a list containing information about assigned and/ or owned projects.

+
+
+

The Project data contains the following information:

+
+
+ +
+
+

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.

+
+
+

Steps

+
+ +++++++ + + + + + + + + + + + + + + + + + + +
NrTitleRole(s)NextDescription

1

Rest API call to get Projects with information

OWNER, SUPERADMIN, USER

Rest api call to get projects with details

+

7.6. Rest API documentation

@@ -7331,6 +7396,9 @@
7.6.1.3. Project administration

  • REST API for UC_062-Admin changes project access level

    • +
  • +

    REST API for UC_081-get assigned project data

    +
    • @@ -8364,7 +8432,7 @@

    7.6.9. Admin downloads all
    -
    $ curl 'https://sechub.example.com/api/admin/scan/download/b3d0fadc-5631-48fe-ad3b-d1d2856e4158' -i -u 'user:secret' -X GET \
+
    $ 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'
    @@ -9529,7 +9597,7 @@

    7.6.20. Admin shows scan logs for pro
    -
    [{"sechubJobUUID":"236cbc48-7499-4aed-9de2-8646de4bf48d","executedBy":"spartakus","started":"2024-10-20T16:59:24.353716812","ended":"2024-10-21T16:59:24.353740156","status":"OK"}]
    +
    [{"sechubJobUUID":"b2a0f621-cbed-431f-816d-f8f5a655e8bc","executedBy":"spartakus","started":"2024-11-26T09:48:46.447108027","ended":"2024-11-27T09:48:46.447126853","status":"OK"}]
    @@ -9906,7 +9974,133 @@

    7.6.23. Admin changes project access
    - +

    7.6.24. get assigned project data

    +
    +

    REST API for usecase UC_081-get assigned project data

    +
    +
    +

    Definition

    +
    + + ++++ + + + + + + + + + + + + + + + + + + + + +
    Table 41. General request information
    Value

    Path

    /api/projects

    Method

    GET

    Status code

    200 OK

    +
    +

    Path parameters

    +
    + + ++++ + + + + + + +
    Table 42. https://localhost:8081/api/projects
    ParameterDescription
    +
    +

    Request headers

    +
    + ++++ + + + + + + +
    NameDescription
    +
    +

    Response fields

    +
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PathTypeDescription

    [].projectId

    String

    Project ID

    [].owner

    String

    Name of owner of the Project

    [].isOwned

    Boolean

    If caller is owner of the project

    [].assignedUsers

    Array

    Optional: Assigned users (only viewable by owner or admin)

    +
    +

    Example

    +
    +
    +

    Curl request

    +
    +
    +
    +
    $ curl 'https://sechub.example.com/api/projects' -i -u 'user:secret' -X GET \
+    -H 'Content-Type: application/json;charset=UTF-8'
    +
    +
    +
    +

    Response body

    +
    +
    +
    +
    [{"projectId":"project1","owner":"user1","assignedUsers":["user1","user2"],"isOwned":true}]
    +
    +
    +
    +
    + @@ -9914,7 +10108,7 @@
    - +@@ -9944,7 +10138,7 @@
    Table 41. General request informationTable 43. General request information
    - +@@ -9980,17 +10174,17 @@
    Table 42. https://localhost:8081/api/anonymous/apitoken/{oneTimeToken}Table 44. https://localhost:8081/api/anonymous/apitoken/{oneTimeToken}
    - +@@ -10020,7 +10214,7 @@
    7.6.25.1. Code Scan variant

    Path parameters

    Table 43. General request informationTable 45. General request information
    - +@@ -10139,17 +10333,17 @@
    7.6.25.1. Code Scan variant
    -
    {"jobId":"e985a705-ffb7-49b1-99e6-1407d27226e4"}
    +
    {"jobId":"7786c4a7-042f-4d2b-8bcf-6c23aabf6e7b"}
    -
    7.6.25.2. Code Scan using data section variant
    +
    7.6.26.2. Code Scan using data section variant

    Definition

    Table 44. https://localhost:8081/api/project/{projectId}/jobTable 46. https://localhost:8081/api/project/{projectId}/job
    - +@@ -10179,7 +10373,7 @@
    7.6.25.2. Code Sc

    Path parameters

    Table 45. General request informationTable 47. General request information
    - +@@ -10318,17 +10512,17 @@
    7.6.25.2. Code Sc
    -
    {"jobId":"2210eb32-7fd0-4299-b75b-0d87a5db26a0"}
    +
    {"jobId":"35ea98be-9e36-4cc6-8c8a-3a157d24ead7"}
    -
    7.6.25.3. Secret scan variant
    +
    7.6.26.3. Secret scan variant

    Definition

    Table 46. https://localhost:8081/api/project/{projectId}/jobTable 48. https://localhost:8081/api/project/{projectId}/job
    - +@@ -10358,7 +10552,7 @@
    7.6.25.3. Secret scan variant

    Path parameters

    Table 47. General request informationTable 49. General request information
    - +@@ -10477,17 +10671,17 @@
    7.6.25.3. Secret scan variant
    -
    {"jobId":"a0e2dc56-54fa-4b25-b1e6-688dd47baaf4"}
    +
    {"jobId":"dc364126-fdc7-40a8-b8e7-ff087eb22bf2"}
    -
    7.6.25.4. License scan variant
    +
    7.6.26.4. License scan variant

    Definition

    Table 48. https://localhost:8081/api/project/{projectId}/jobTable 50. https://localhost:8081/api/project/{projectId}/job
    - +@@ -10517,7 +10711,7 @@
    7.6.25.4. License scan variantPath parameters

    Table 49. General request informationTable 51. General request information
    - +@@ -10636,17 +10830,17 @@
    7.6.25.4. License scan variant
    -
    {"jobId":"e7c1d895-bc81-4c70-92ad-7ca117bab44a"}
    +
    {"jobId":"7ff1f27b-bae9-4593-b4ee-5a5df3e52604"}
    -
    7.6.25.5. Infrastructure scan variant
    +
    7.6.26.5. Infrastructure scan variant

    Definition

    Table 50. https://localhost:8081/api/project/{projectId}/jobTable 52. https://localhost:8081/api/project/{projectId}/job
    - +@@ -10676,7 +10870,7 @@
    7.6.25.5. Infrastructure s

    Path parameters

    Table 51. General request informationTable 53. General request information
    - +@@ -10790,17 +10984,17 @@
    7.6.25.5. Infrastructure s
    -
    {"jobId":"953dff35-71f1-4983-b360-0762a95ca7c0"}
    +
    {"jobId":"fcf8cb7f-4f7c-413a-9978-ce8a085fbc7f"}
    -
    7.6.25.6. Web scan anonymous variant
    +
    7.6.26.6. Web scan anonymous variant

    Definition

    Table 52. https://localhost:8081/api/project/{projectId}/jobTable 54. https://localhost:8081/api/project/{projectId}/job
    - +@@ -10830,7 +11024,7 @@
    7.6.25.6. Web scan anonymou

    Path parameters

    Table 53. General request informationTable 55. General request information
    - +@@ -10959,17 +11153,17 @@
    7.6.25.6. Web scan anonymou
    -
    {"jobId":"9bb88784-b24d-436e-898a-40e9e9c9d42b"}
    +
    {"jobId":"42566c19-7464-4f4a-95e6-79e722ae39b7"}
    -
    7.6.25.7. Web scan with api definition variant
    +
    7.6.26.7. Web scan with api definition variant

    Definition

    Table 54. https://localhost:8081/api/project/{projectId}/jobTable 56. https://localhost:8081/api/project/{projectId}/job
    - +@@ -10999,7 +11193,7 @@
    7.6.25.7. Web sca

    Path parameters

    Table 55. General request informationTable 57. General request information
    - +@@ -11123,17 +11317,17 @@
    7.6.25.7. Web sca
    -
    {"jobId":"39b31e69-97ca-4543-99a6-50c4f6cc075b"}
    +
    {"jobId":"1ad5cd3b-5a1e-4a7e-8b07-8d5bd87dd515"}
    -
    7.6.25.8. Web scan with client certificate definition variant
    +
    7.6.26.8. Web scan with client certificate definition variant

    Definition

    Table 56. https://localhost:8081/api/project/{projectId}/jobTable 58. https://localhost:8081/api/project/{projectId}/job
    - +@@ -11163,7 +11357,7 @@
    7.

    Path parameters

    Table 57. General request informationTable 59. General request information
    - +@@ -11282,17 +11476,17 @@
    7.
    -
    {"jobId":"df9ee013-ee60-45bb-929a-1f2bb410f153"}
    +
    {"jobId":"019ef25e-a21a-4c9e-9412-2ec55887f291"}
    -
    7.6.25.9. Web Scan login basic variant
    +
    7.6.26.9. Web Scan login basic variant

    Definition

    Table 58. https://localhost:8081/api/project/{projectId}/jobTable 60. https://localhost:8081/api/project/{projectId}/job
    - +@@ -11322,7 +11516,7 @@
    7.6.25.9. Web Scan login

    Path parameters

    Table 59. General request informationTable 61. General request information
    - +@@ -11456,17 +11650,17 @@
    7.6.25.9. Web Scan login
    -
    {"jobId":"57628d15-8dd2-4b28-b9fa-42e0c6037c43"}
    +
    {"jobId":"b7960f36-3dcd-4030-a4d1-fa8ba4f99462"}
    -
    7.6.25.10. Web Scan login form scripted variant
    +
    7.6.26.10. Web Scan login form scripted variant

    Definition

    Table 60. https://localhost:8081/api/project/{projectId}/jobTable 62. https://localhost:8081/api/project/{projectId}/job
    - +@@ -11496,7 +11690,7 @@
    7.6.25.10. Web Sc

    Path parameters

    Table 61. General request informationTable 63. General request information
    - +@@ -11675,17 +11869,17 @@
    7.6.25.10. Web Sc
    -
    {"jobId":"d47f3a92-0951-4447-8300-fad04567f65b"}
    +
    {"jobId":"d70e8d78-f3c9-4d16-a57f-9f4957e4723a"}
    -
    7.6.25.11. Web Scan headers variant
    +
    7.6.26.11. Web Scan headers variant

    Definition

    Table 62. https://localhost:8081/api/project/{projectId}/jobTable 64. https://localhost:8081/api/project/{projectId}/job
    - +@@ -11715,7 +11909,7 @@
    7.6.25.11. Web Scan headers v

    Path parameters

    Table 63. General request informationTable 65. General request information
    - +@@ -11839,13 +12033,13 @@
    7.6.25.11. Web Scan headers v
    -
    {"jobId":"37527d26-9792-44ae-a2c8-36dfb67fe36c"}
    +
    {"jobId":"67515a5b-1f33-4d6b-b432-1ed5ba525ee0"}
    -

    7.6.26. User uploads source code

    +

    7.6.27. User uploads source code

    REST API for usecase UC_006-User uploads source code

    @@ -11853,7 +12047,7 @@

    7.6.26. User uploads source code

    Definition

    Table 64. https://localhost:8081/api/project/{projectId}/jobTable 66. https://localhost:8081/api/project/{projectId}/job
    - +@@ -11883,7 +12077,7 @@

    7.6.26. User uploads source code

    Path parameters

    Table 65. General request informationTable 67. General request information
    - +@@ -11906,6 +12100,27 @@

    7.6.26. User uploads source code

    Table 66. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/sourcecodeTable 68. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/sourcecode
    +

    Query parameters

    +
    + ++++ + + + + + + + + + + + + +
    ParameterDescription

    checkSum

    A sha256 checksum for file upload validation

    +

    Request headers

    @@ -11928,7 +12143,7 @@

    7.6.26. User uploads source code

    -
    $ curl 'https://sechub.example.com/api/project/project1/job/dc48eaff-3a7d-414f-82f6-f242dcd9bf74/sourcecode?checkSum=checkSumValue' -i -X POST \
+
    $ 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 @@ 
    7.6.26. User uploads source code
    -

    7.6.27. User approves sechub job

    +

    7.6.28. User approves sechub job

    REST API for usecase UC_007-User approves sechub job

    @@ -11950,7 +12165,7 @@

    7.6.27. User approves sechub job

    Definition

    - +@@ -11980,7 +12195,7 @@

    7.6.27. User approves sechub job

    Path parameters

    Table 67. General request informationTable 69. General request information
    - +@@ -12025,7 +12240,7 @@

    7.6.27. User approves sechub job

    -
    $ curl 'https://sechub.example.com/api/project/project1/job/bb20198d-8bb8-4ff5-961c-4fc6ecddd80d/approve' -i -X PUT \
+
    $ 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'
    @@ -12035,7 +12250,7 @@

    7.6.27. User approves sechub job

    -

    7.6.28. User checks sechub job state

    +

    7.6.29. User checks sechub job state

    @@ -12043,7 +12258,7 @@

    7.6.28. User checks sechub job state

    Definition

    Table 68. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/approveTable 70. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/approve
    - +@@ -12073,7 +12288,7 @@

    7.6.28. User checks sechub job state

    Path parameters

    Table 69. General request informationTable 71. General request information
    - +@@ -12177,7 +12392,7 @@

    7.6.28. User checks sechub job state

    -
    $ curl 'https://sechub.example.com/api/project/project1/job/abb3751f-2ca5-4f0c-bae1-04a0e1788550' -i -X GET \
+
    $ 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'
    @@ -12186,22 +12401,22 @@

    7.6.28. User checks sechub job state

    -
    {"jobUUID":"abb3751f-2ca5-4f0c-bae1-04a0e1788550","owner":"CREATOR1","created":"","started":"2024-10-21T16:44:22.764797265","ended":"2024-10-21T16:59:22.764824576","state":"ENDED","result":"OK","trafficLight":"GREEN"}
    +
    {"jobUUID":"92179639-e089-4894-a4df-14f1e40e453d","owner":"CREATOR1","created":"","started":"2024-11-27T09:33:44.986322732","ended":"2024-11-27T09:48:44.986349833","state":"ENDED","result":"OK","trafficLight":"GREEN"}
    -

    7.6.29. User downloads sechub job report

    +

    7.6.30. User downloads sechub job report

    -
    7.6.29.1. JSON variant
    +
    7.6.30.1. JSON variant

    Definition

    Table 70. https://localhost:8081/api/project/{projectId}/job/{jobUUID}Table 72. https://localhost:8081/api/project/{projectId}/job/{jobUUID}
    - +@@ -12231,7 +12446,7 @@
    7.6.29.1. JSON variant

    Path parameters

    Table 71. General request informationTable 73. General request information
    - +@@ -12261,19 +12476,19 @@
    7.6.29.1. JSON variant
    -
    $ curl 'https://sechub.example.com/api/project/project1/report/7a8b89cc-f4dd-44ac-bae6-212bc2dd01d0' -i -u 'user:secret' -X GET \
+
    $ 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'
    -
    7.6.29.2. HTML variant
    +
    7.6.30.2. HTML variant

    Definition

    Table 72. https://localhost:8081/api/project/{projectId}/report/{jobUUID}Table 74. https://localhost:8081/api/project/{projectId}/report/{jobUUID}
    - +@@ -12303,7 +12518,7 @@
    7.6.29.2. HTML variant

    Path parameters

    Table 73. General request informationTable 75. General request information
    - +@@ -12333,7 +12548,7 @@
    7.6.29.2. HTML variant
    -
    $ curl 'https://sechub.example.com/api/project/project1/report/6f4f16d2-8e58-4ed3-b41c-110b74370d7c' -i -u 'user:secret' -X GET \
+
    $ 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'
    @@ -12341,7 +12556,7 @@
    7.6.29.2. HTML variant
    -

    7.6.30. User marks false positives

    +

    7.6.31. User marks false positives

    @@ -12349,7 +12564,7 @@

    7.6.30. User marks false positives

    Definition

    Table 74. https://localhost:8081/api/project/{projectId}/report/{jobUUID}Table 76. https://localhost:8081/api/project/{projectId}/report/{jobUUID}
    - +@@ -12379,7 +12594,7 @@

    7.6.30. User marks false positives

    Path parameters

    Table 75. General request informationTable 77. General request information
    - +@@ -12515,7 +12730,7 @@

    7.6.30. User marks false positives

    -

    7.6.31. User unmarks existing false positive definitons

    +

    7.6.32. User unmarks existing false positive definitons

    @@ -12523,7 +12738,7 @@

    7.6.31. User unmarks ex

    Definition

    Table 76. https://localhost:8081/api/project/{projectId}/false-positivesTable 78. https://localhost:8081/api/project/{projectId}/false-positives
    - +@@ -12553,7 +12768,7 @@

    7.6.31. User unmarks ex

    Path parameters

    Table 77. General request informationTable 79. General request information
    - +@@ -12611,7 +12826,7 @@

    7.6.31. User unmarks ex
    -

    7.6.32. User fetches false positive configuration of project

    +

    7.6.33. User fetches false positive configuration of project

    @@ -12619,7 +12834,7 @@

    7.6.32. User fetch

    Definition

    Table 78. https://localhost:8081/api/project/{projectId}/false-positive/{jobUUID}/{findingId}Table 80. https://localhost:8081/api/project/{projectId}/false-positive/{jobUUID}/{findingId}
    - +@@ -12649,7 +12864,7 @@

    7.6.32. User fetch

    Path parameters

    Table 79. General request informationTable 81. General request information
    - +@@ -12872,7 +13087,7 @@

    7.6.32. User fetch
    -

    7.6.33. User uploads binaries

    +

    7.6.34. User uploads binaries

    REST API for usecase UC_069-User uploads binaries

    @@ -12880,7 +13095,7 @@

    7.6.33. User uploads binaries

    Definition

    Table 80. https://localhost:8081/api/project/{projectId}/false-positivesTable 82. https://localhost:8081/api/project/{projectId}/false-positives
    - +@@ -12910,7 +13125,7 @@

    7.6.33. User uploads binaries

    Path parameters

    Table 81. General request informationTable 83. General request information
    - +@@ -12961,7 +13176,7 @@

    7.6.33. User uploads binaries

    -
    $ curl 'https://sechub.example.com/api/project/project1/job/b8b8b952-dadf-44b7-9480-c0276657f991/binaries' -i -X POST \
+
    $ 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 @@ 
    7.6.33. User uploads binaries
    -

    7.6.34. User downloads job report in SPDX format

    +

    7.6.35. User downloads job report in SPDX format

    @@ -12982,7 +13197,7 @@

    7.6.34. User downloads job rep

    Definition

    Table 82. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/binariesTable 84. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/binaries
    - +@@ -13012,7 +13227,7 @@

    7.6.34. User downloads job rep

    Path parameters

    Table 83. General request informationTable 85. General request information
    - +@@ -13042,14 +13257,14 @@

    7.6.34. User downloads job rep
    -
    $ curl 'https://sechub.example.com/api/project/project1/report/spdx/4f730441-ec48-4a4f-ad1d-e57932c4d802' -i -u 'user:secret' -X GET \
+
    $ 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'
    -

    7.6.35. User unmarks existing false positive project data definitons

    +

    7.6.36. User unmarks existing false positive project data definitons

    @@ -13057,7 +13272,7 @@

    7.6.35. Us

    Definition

    Table 84. https://localhost:8081/api/project/{projectId}/report/spdx/{jobUUID}Table 86. https://localhost:8081/api/project/{projectId}/report/spdx/{jobUUID}
    - +@@ -13087,7 +13302,7 @@

    7.6.35. Us

    Path parameters

    Table 85. General request informationTable 87. General request information
    - +@@ -13141,7 +13356,7 @@

    7.6.35. Us
    -

    7.6.36. User self registration

    +

    7.6.37. User self registration

    REST API for usecase UC_001-User self registration

    @@ -13149,7 +13364,7 @@

    7.6.36. User self registration

    Definition

    Table 86. https://localhost:8081/api/project/{projectId}/false-positive/project-data/{id}Table 88. https://localhost:8081/api/project/{projectId}/false-positive/project-data/{id}
    - +@@ -13228,7 +13443,7 @@

    7.6.36. User self registration

    -

    7.6.37. Admin lists open user signups

    +

    7.6.38. Admin lists open user signups

    @@ -13236,7 +13451,7 @@

    7.6.37. Admin lists open user signups

    Definition

    Table 87. General request informationTable 89. General request information
    - +@@ -13332,7 +13547,7 @@

    7.6.37. Admin lists open user signups

    -

    7.6.38. Admin applies self registration

    +

    7.6.39. Admin applies self registration

    @@ -13340,7 +13555,7 @@

    7.6.38. Admin applies self registration

    Definition

    Table 88. General request informationTable 90. General request information
    - +@@ -13370,7 +13585,7 @@

    7.6.38. Admin applies self registration

    Path parameters

    Table 89. General request informationTable 91. General request information
    - +@@ -13420,7 +13635,7 @@

    7.6.38. Admin applies self registration
    -

    7.6.39. Admin deletes user signup

    +

    7.6.40. Admin deletes user signup

    REST API for usecase UC_019-Admin deletes user signup

    @@ -13428,7 +13643,7 @@

    7.6.39. Admin deletes user signup

    Definition

    Table 90. https://localhost:8081/api/admin/signup/accept/{userId}Table 92. https://localhost:8081/api/admin/signup/accept/{userId}
    - +@@ -13458,7 +13673,7 @@

    7.6.39. Admin deletes user signup

    Path parameters

    Table 91. General request informationTable 93. General request information
    - +@@ -13508,7 +13723,7 @@

    7.6.39. Admin deletes user signup

    -

    7.6.40. User requests new API token

    +

    7.6.41. User requests new API token

    @@ -13516,7 +13731,7 @@

    7.6.40. User requests new API token

    Definition

    Table 92. https://localhost:8081/api/admin/signup/{userId}Table 94. https://localhost:8081/api/admin/signup/{userId}
    - +@@ -13546,7 +13761,7 @@

    7.6.40. User requests new API token

    Path parameters

    Table 93. General request informationTable 95. General request information
    - +@@ -13582,7 +13797,7 @@

    7.6.40. User requests new API token

    -

    7.6.41. Admin lists all running jobs

    +

    7.6.42. Admin lists all running jobs

    @@ -13590,7 +13805,7 @@

    7.6.41. Admin lists all running jobs

    Definition

    Table 94. https://localhost:8081/api/anonymous/refresh/apitoken/{emailAddress}Table 96. https://localhost:8081/api/anonymous/refresh/apitoken/{emailAddress}
    - +@@ -13692,12 +13907,12 @@

    7.6.41. Admin lists all running jobs

    -
    [{"jobUUID":"aa8cee6d-756f-414d-8134-3159bdd75f44","projectId":"project-name","owner":"owner-userid","status":"RUNNING","since":"2024-10-21T16:59:27.703658282"}]
    +
    [{"jobUUID":"a8503241-c02c-4722-afce-7a54eb0e7ea0","projectId":"project-name","owner":"owner-userid","status":"RUNNING","since":"2024-11-27T09:48:49.769371918"}]
    -

    7.6.42. Admin cancels a job

    +

    7.6.43. Admin cancels a job

    REST API for usecase UC_034-Admin cancels a job

    @@ -13705,7 +13920,7 @@

    7.6.42. Admin cancels a job

    Definition

    Table 95. General request informationTable 97. General request information
    - +@@ -13735,7 +13950,7 @@

    7.6.42. Admin cancels a job

    Path parameters

    Table 96. General request informationTable 98. General request information
    - +@@ -13776,7 +13991,7 @@

    7.6.42. Admin cancels a job

    -
    $ curl 'https://sechub.example.com/api/admin/jobs/cancel/92f9bfd4-051b-455b-b7b8-ffc1f6db45f6' -i -u 'user:secret' -X POST \
+
    $ 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'
    @@ -13786,7 +14001,7 @@

    7.6.42. Admin cancels a job

    -

    7.6.43. Admin restarts a job

    +

    7.6.44. Admin restarts a job

    REST API for usecase UC_041-Admin restarts a job

    @@ -13794,7 +14009,7 @@

    7.6.43. Admin restarts a job

    Definition

    Table 97. https://localhost:8081/api/admin/jobs/cancel/{jobUUID}Table 99. https://localhost:8081/api/admin/jobs/cancel/{jobUUID}
    - +@@ -13824,7 +14039,7 @@

    7.6.43. Admin restarts a job

    Path parameters

    Table 98. General request informationTable 100. General request information
    - +@@ -13865,7 +14080,7 @@

    7.6.43. Admin restarts a job

    -
    $ curl 'https://sechub.example.com/api/admin/jobs/restart/be57747a-0731-4a35-ab3a-722e4f454077' -i -u 'user:secret' -X POST \
+
    $ 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'
    @@ -13875,7 +14090,7 @@

    7.6.43. Admin restarts a job

    -

    7.6.44. Admin restarts a job (hard)

    +

    7.6.45. Admin restarts a job (hard)

    @@ -13883,7 +14098,7 @@

    7.6.44. Admin restarts a job (hard)

    Definition

    Table 99. https://localhost:8081/api/admin/jobs/restart/{jobUUID}Table 101. https://localhost:8081/api/admin/jobs/restart/{jobUUID}
    - +@@ -13913,7 +14128,7 @@

    7.6.44. Admin restarts a job (hard)

    Path parameters

    Table 100. General request informationTable 102. General request information
    - +@@ -13954,7 +14169,7 @@

    7.6.44. Admin restarts a job (hard)

    -
    $ curl 'https://sechub.example.com/api/admin/jobs/restart-hard/c9aea17c-1fe0-4c11-b1c5-fe21aa3ec9bb' -i -u 'user:secret' -X POST \
+
    $ 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'
    @@ -13964,7 +14179,7 @@

    7.6.44. Admin restarts a job (hard)

    -

    7.6.45. User defines mock data configuration for project

    +

    7.6.46. User defines mock data configuration for project

    @@ -13972,7 +14187,7 @@

    7.6.45. User defines m

    Definition

    Table 101. https://localhost:8081/api/admin/jobs/restart-hard/{jobUUID}Table 103. https://localhost:8081/api/admin/jobs/restart-hard/{jobUUID}
    - +@@ -14033,7 +14248,7 @@

    7.6.45. User defines m
    -

    7.6.46. User retrieves mock data configuration for project

    +

    7.6.47. User retrieves mock data configuration for project

    @@ -14041,7 +14256,7 @@

    7.6.46. User retriev

    Definition

    Table 102. General request informationTable 104. General request information
    - +@@ -14105,7 +14320,7 @@

    7.6.46. User retriev
    -

    7.6.47. Admin updates mapping configuration

    +

    7.6.48. Admin updates mapping configuration

    @@ -14113,7 +14328,7 @@

    7.6.47. Admin updates mapping confi

    Definition

    Table 103. General request informationTable 105. General request information
    - +@@ -14143,7 +14358,7 @@

    7.6.47. Admin updates mapping confi

    Path parameters

    Table 104. General request informationTable 106. General request information
    - +@@ -14229,7 +14444,7 @@

    7.6.47. Admin updates mapping confi
    -

    7.6.48. Admin fetches mapping configuration

    +

    7.6.49. Admin fetches mapping configuration

    @@ -14237,7 +14452,7 @@

    7.6.48. Admin fetches mapping confi

    Definition

    Table 105. https://localhost:8081/api/admin/config/mapping/{mappingId}Table 107. https://localhost:8081/api/admin/config/mapping/{mappingId}
    - +@@ -14267,7 +14482,7 @@

    7.6.48. Admin fetches mapping confi

    Path parameters

    Table 106. General request informationTable 108. General request information
    - +@@ -14356,7 +14571,7 @@

    7.6.48. Admin fetches mapping confi
    -

    7.6.49. Admin creates an executor configuration

    +

    7.6.50. Admin creates an executor configuration

    @@ -14364,7 +14579,7 @@

    7.6.49. Admin creates an execut

    Definition

    Table 107. https://localhost:8081/api/admin/config/mapping/{mappingId}Table 109. https://localhost:8081/api/admin/config/mapping/{mappingId}
    - +@@ -14487,12 +14702,12 @@

    7.6.49. Admin creates an execut
    -
    85aa1ed2-4c62-41e0-90b8-5aaccda85f11
    +
    b922b3e7-3416-4d74-8b1a-81fbe61a3f63
    -

    7.6.50. Admin deletes executor configuration

    +

    7.6.51. Admin deletes executor configuration

    @@ -14500,7 +14715,7 @@

    7.6.50. Admin deletes executor con

    Definition

    Table 108. General request informationTable 110. General request information
    - +@@ -14530,7 +14745,7 @@

    7.6.50. Admin deletes executor con

    Path parameters

    Table 109. General request informationTable 111. General request information
    - +@@ -14571,7 +14786,7 @@

    7.6.50. Admin deletes executor con
    -
    $ curl 'https://sechub.example.com/api/admin/config/executor/01252350-78be-4eed-8103-d4c8dadcb1d5' -i -u 'user:secret' -X DELETE \
+
    $ 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'
    @@ -14581,7 +14796,7 @@

    7.6.50. Admin deletes executor con
    -

    7.6.51. Admin fetches executor configuration list

    +

    7.6.52. Admin fetches executor configuration list

    @@ -14589,7 +14804,7 @@

    7.6.51. Admin fetches executo

    Definition

    Table 110. https://localhost:8081/api/admin/config/executor/{uuid}Table 112. https://localhost:8081/api/admin/config/executor/{uuid}
    - +@@ -14686,12 +14901,12 @@

    7.6.51. Admin fetches executo
    -
    {"executorConfigurations":[{"uuid":"decbe618-fb22-42fd-ad28-9a98d629f981","name":"example configuration","enabled":true}],"type":"executorConfigurationList"}
    +
    {"executorConfigurations":[{"uuid":"fd85ad57-94c1-4671-a1ea-100fcb679201","name":"example configuration","enabled":true}],"type":"executorConfigurationList"}
    -

    7.6.52. Admin fetches executor configuration

    +

    7.6.53. Admin fetches executor configuration

    @@ -14699,7 +14914,7 @@

    7.6.52. Admin fetches executor con

    Definition

    Table 111. General request informationTable 113. General request information
    - +@@ -14729,7 +14944,7 @@

    7.6.52. Admin fetches executor con

    Path parameters

    Table 112. General request informationTable 114. General request information
    - +@@ -14839,7 +15054,7 @@

    7.6.52. Admin fetches executor con
    -
    $ curl 'https://sechub.example.com/api/admin/config/executor/d3da4fff-26ac-424d-a207-4653dbff9ca8' -i -u 'user:secret' -X GET \
+
    $ 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'
    @@ -14848,12 +15063,12 @@

    7.6.52. Admin fetches executor con
    -
    {"uuid":"d3da4fff-26ac-424d-a207-4653dbff9ca8","name":"New name","productIdentifier":"PDS_CODESCAN","setup":{"baseURL":"https://product.example.com","credentials":{"user":"env:EXAMPLE_USENAME","password":"env:EXAMPLE_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value"}]},"executorVersion":1,"enabled":false}
    +
    {"uuid":"cf306d66-846b-4bc2-a66e-5b60055aaa70","name":"New name","productIdentifier":"PDS_CODESCAN","setup":{"baseURL":"https://product.example.com","credentials":{"user":"env:EXAMPLE_USENAME","password":"env:EXAMPLE_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value"}]},"executorVersion":1,"enabled":false}
    -

    7.6.53. Admin updates executor configuration setup

    +

    7.6.54. Admin updates executor configuration setup

    @@ -14861,7 +15076,7 @@

    7.6.53. Admin updates execut

    Definition

    Table 113. https://localhost:8081/api/admin/config/executor/{uuid}Table 115. https://localhost:8081/api/admin/config/executor/{uuid}
    - +@@ -14891,7 +15106,7 @@

    7.6.53. Admin updates execut

    Path parameters

    Table 114. General request informationTable 116. General request information
    - +@@ -14996,7 +15211,7 @@

    7.6.53. Admin updates execut
    -
    $ curl 'https://sechub.example.com/api/admin/config/executor/150289d5-3831-4eac-80ed-337c2ff30949' -i -u 'user:secret' -X PUT \
+
    $ 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"}]}}'
    @@ -15007,7 +15222,7 @@

    7.6.53. Admin updates execut

    -

    7.6.54. Admin creates an execution profile

    +

    7.6.55. Admin creates an execution profile

    @@ -15015,7 +15230,7 @@

    7.6.54. Admin creates an execution p

    Definition

    Table 115. https://localhost:8081/api/admin/config/executor/{uuid}Table 117. https://localhost:8081/api/admin/config/executor/{uuid}
    - +@@ -15045,7 +15260,7 @@

    7.6.54. Admin creates an execution p

    Path parameters

    Table 116. General request informationTable 118. General request information
    - +@@ -15136,7 +15351,7 @@

    7.6.54. Admin creates an execution p
    -

    7.6.55. Admin deletes execution profile

    +

    7.6.56. Admin deletes execution profile

    @@ -15144,7 +15359,7 @@

    7.6.55. Admin deletes execution profile

    Definition

    Table 117. https://localhost:8081/api/admin/config/execution/profile/{profileId}Table 119. https://localhost:8081/api/admin/config/execution/profile/{profileId}
    - +@@ -15174,7 +15389,7 @@

    7.6.55. Admin deletes execution profile

    Path parameters

    Table 118. General request informationTable 120. General request information
    - +@@ -15225,7 +15440,7 @@

    7.6.55. Admin deletes execution profile
    -

    7.6.56. Admin updates execution profile

    +

    7.6.57. Admin updates execution profile

    @@ -15233,7 +15448,7 @@

    7.6.56. Admin updates execution profile

    Definition

    Table 119. https://localhost:8081/api/admin/config/execution/profile/{profileId}Table 121. https://localhost:8081/api/admin/config/execution/profile/{profileId}
    - +@@ -15263,7 +15478,7 @@

    7.6.56. Admin updates execution profile

    Path parameters

    Table 120. General request informationTable 122. General request information
    - +@@ -15340,7 +15555,7 @@

    7.6.56. Admin updates execution profile 
    $ 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}'
    + -d '{"description":"changed description","configurations":[{"uuid":"5a8e548a-169d-4642-8d2d-00bed1357847","executorVersion":0,"enabled":false,"setup":{"credentials":{},"jobParameters":[]}}],"enabled":true}'
    @@ -15349,7 +15564,7 @@

    7.6.56. Admin updates execution profile

    -

    7.6.57. Admin fetches execution profile

    +

    7.6.58. Admin fetches execution profile

    @@ -15357,7 +15572,7 @@

    7.6.57. Admin fetches execution profile

    Definition

    Table 121. https://localhost:8081/api/admin/config/execution/profile/{profileId}Table 123. https://localhost:8081/api/admin/config/execution/profile/{profileId}
    - +@@ -15387,7 +15602,7 @@

    7.6.57. Admin fetches execution profile

    Path parameters

    Table 122. General request informationTable 124. General request information
    - +@@ -15496,12 +15711,12 @@

    7.6.57. Admin fetches execution profile
    -
    {"description":"a description","enabled":true,"configurations":[{"uuid":"f8dd3854-ae30-450a-828a-1b715bcd57d3","name":"New name","productIdentifier":"PDS_CODESCAN","setup":{"baseURL":"https://product.example.com","credentials":{"user":"env:EXAMPLE_USENAME","password":"env:EXAMPLE_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value but changed. Remark: the other parameter (example.key2) has been removed by this call"}]},"executorVersion":1,"enabled":false}],"projectIds":["project-1","project-2"]}
    +
    {"description":"a description","enabled":true,"configurations":[{"uuid":"006a3f33-85f6-4586-a509-5ef17c40004b","name":"New name","productIdentifier":"PDS_CODESCAN","setup":{"baseURL":"https://product.example.com","credentials":{"user":"env:EXAMPLE_USENAME","password":"env:EXAMPLE_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value but changed. Remark: the other parameter (example.key2) has been removed by this call"}]},"executorVersion":1,"enabled":false}],"projectIds":["project-1","project-2"]}
    -

    7.6.58. Admin fetches execution profile list

    +

    7.6.59. Admin fetches execution profile list

    @@ -15509,7 +15724,7 @@

    7.6.58. Admin fetches execution pr

    Definition

    Table 123. https://localhost:8081/api/admin/config/execution/profile/{profileId}Table 125. https://localhost:8081/api/admin/config/execution/profile/{profileId}
    - +@@ -15611,7 +15826,7 @@

    7.6.58. Admin fetches execution pr
    -

    7.6.59. Admin assigns execution profile to project

    +

    7.6.60. Admin assigns execution profile to project

    @@ -15619,7 +15834,7 @@

    7.6.59. Admin assigns execut

    Definition

    Table 124. General request informationTable 126. General request information
    - +@@ -15649,7 +15864,7 @@

    7.6.59. Admin assigns execut

    Path parameters

    Table 125. General request informationTable 127. General request information
    - +@@ -15704,7 +15919,7 @@

    7.6.59. Admin assigns execut
    -

    7.6.60. Admin unassigns execution profile from project

    +

    7.6.61. Admin unassigns execution profile from project

    @@ -15712,7 +15927,7 @@

    7.6.60. Admin unassigns

    Definition

    Table 126. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}Table 128. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}
    - +@@ -15742,7 +15957,7 @@

    7.6.60. Admin unassigns

    Path parameters

    Table 127. General request informationTable 129. General request information
    - +@@ -15797,7 +16012,7 @@

    7.6.60. Admin unassigns
    -

    7.6.61. Admin fetches auto cleanup configuration

    +

    7.6.62. Admin fetches auto cleanup configuration

    @@ -15805,7 +16020,7 @@

    7.6.61. Admin fetches auto cle

    Definition

    Table 128. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}Table 130. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}
    - +@@ -15868,7 +16083,7 @@

    7.6.61. Admin fetches auto cle
    -

    7.6.62. Admin updates auto cleanup configuration

    +

    7.6.63. Admin updates auto cleanup configuration

    @@ -15876,7 +16091,7 @@

    7.6.62. Admin updates auto cle

    Definition

    Table 129. General request informationTable 131. General request information
    - +@@ -15936,7 +16151,7 @@

    7.6.62. Admin updates auto cle
    -

    7.6.63. Admin starts encryption rotation

    +

    7.6.64. Admin starts encryption rotation

    @@ -15944,7 +16159,7 @@

    7.6.63. Admin starts encryption rotati

    Definition

    Table 130. General request informationTable 132. General request information
    - +@@ -16008,7 +16223,7 @@

    7.6.63. Admin starts encryption rotati
    -

    7.6.64. Admin fetches encryption status

    +

    7.6.65. Admin fetches encryption status

    @@ -16016,7 +16231,7 @@

    7.6.64. Admin fetches encryption status

    Definition

    Table 131. General request informationTable 133. General request information
    - +@@ -16148,7 +16363,7 @@

    7.6.64. Admin fetches encryption status
    -

    7.6.65. Admin disables job processing in scheduler

    +

    7.6.66. Admin disables job processing in scheduler

    @@ -16156,7 +16371,7 @@

    7.6.65. Admin disables job p

    Definition

    Table 132. General request informationTable 134. General request information
    - +@@ -16215,7 +16430,7 @@

    7.6.65. Admin disables job p
    -

    7.6.66. Admin enables scheduler job processing

    +

    7.6.67. Admin enables scheduler job processing

    @@ -16223,7 +16438,7 @@

    7.6.66. Admin enables scheduler

    Definition

    Table 133. General request informationTable 135. General request information
    - +@@ -16282,7 +16497,7 @@

    7.6.66. Admin enables scheduler
    -

    7.6.67. Admin get scheduler status

    +

    7.6.68. Admin get scheduler status

    @@ -16290,7 +16505,7 @@

    7.6.67. Admin get scheduler status

    Definition

    Table 134. General request informationTable 136. General request information
    - +@@ -16349,7 +16564,7 @@

    7.6.67. Admin get scheduler status

    -

    7.6.68. Admin lists status information

    +

    7.6.69. Admin lists status information

    @@ -16357,7 +16572,7 @@

    7.6.68. Admin lists status informationDefinition

    Table 135. General request informationTable 137. General request information
    - +@@ -16449,7 +16664,7 @@

    7.6.68. Admin lists status information
    -

    7.6.69. Admin fetches server runtime data

    +

    7.6.70. Admin fetches server runtime data

    @@ -16457,7 +16672,7 @@

    7.6.69. Admin fetches server runtime

    Definition

    Table 136. General request informationTable 138. General request information
    - +@@ -16529,7 +16744,7 @@

    7.6.69. Admin fetches server runtime
    -

    7.6.70. User lists jobs for project

    +

    7.6.71. User lists jobs for project

    @@ -16537,7 +16752,7 @@

    7.6.70. User lists jobs for project

    Definition

    Table 137. General request informationTable 139. General request information
    - +@@ -16567,7 +16782,7 @@

    7.6.70. User lists jobs for project

    Path parameters

    Table 138. General request informationTable 140. General request information
    - +@@ -16586,6 +16801,41 @@

    7.6.70. User lists jobs for project

    Table 139. https://localhost:8081/api/project/{projectId}/jobsTable 141. https://localhost:8081/api/project/{projectId}/jobs
    +

    Query parameters

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterDescription

    size

    The wanted (maximum) size for the result set. When not defined, the default will be 1.

    page

    The wanted page number. When not defined, the default will be 0.

    metadata.labels.*

    An optional dynamic query parameter to filter jobs by labels. The syntax is 'metadata.labels.${labelKey}=${labelValue}'.

    +

    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.

    withMetaData

    An optional parameter to define if meta data shall be fetched as well. When not defined, the default will be false.

    +

    Request headers

    @@ -16691,7 +16941,7 @@

    7.6.70. User lists jobs for project

    -
    {"page":0,"totalPages":1,"content":[{"jobUUID":"4fc54538-9eab-4eb5-9da4-9d1cc0897760","executedBy":"User1","created":"2024-10-21T16:42:22.956477277","started":"2024-10-21T16:44:22.956508736","ended":"2024-10-21T16:59:22.956525658","executionState":"ENDED","trafficLight":"GREEN","executionResult":"OK","metaData":{"labels":{"stage":"test"}}}]}
    +
    {"page":0,"totalPages":1,"content":[{"jobUUID":"8d080df1-24cd-470f-b8bd-845baf4b7d60","executedBy":"User1","created":"2024-11-27T09:31:45.196835109","started":"2024-11-27T09:33:45.196866799","ended":"2024-11-27T09:48:45.19687809","executionState":"ENDED","trafficLight":"GREEN","executionResult":"OK","metaData":{"labels":{"stage":"test"}}}]}
    @@ -18220,7 +18470,7 @@

    8.2.3. General configuration

    The next text blocks describe the keys available on SecHub:

    - +@@ -18248,7 +18498,7 @@

    8.2.3. General configuration

    Table 140. Scope 'administration'Table 142. Scope 'administration'
    - +@@ -18270,7 +18520,7 @@

    8.2.3. General configuration

    Table 141. Scope 'anonymous'Table 143. Scope 'anonymous'
    - +@@ -18302,7 +18552,7 @@

    8.2.3. General configuration

    Table 142. Scope 'checkmarx'Table 144. Scope 'checkmarx'
    - +@@ -18334,7 +18584,7 @@

    8.2.3. General configuration

    Table 143. Scope 'initial'Table 145. Scope 'initial'
    - +@@ -18356,7 +18606,7 @@

    8.2.3. General configuration

    Table 144. Scope 'migration'Table 146. Scope 'migration'
    - +@@ -18378,7 +18628,7 @@

    8.2.3. General configuration

    Table 145. Scope 'mock'Table 147. Scope 'mock'
    - +@@ -18455,7 +18705,7 @@

    8.2.3. General configuration

    Table 146. Scope 'nessus'Table 148. Scope 'nessus'
    - +@@ -18527,7 +18777,7 @@

    8.2.3. General configuration

    Table 147. Scope 'netsparker'Table 149. Scope 'netsparker'
    - +@@ -18549,7 +18799,7 @@

    8.2.3. General configuration

    Table 148. Scope 'new'Table 150. Scope 'new'
    - +@@ -18580,8 +18830,8 @@

    8.2.3. General configuration

    Table 149. Scope 'notification'Table 151. Scope 'notification'
    - - +
    Table 150. Scope 'p'
    +@@ -18596,26 +18846,6 @@

    8.2.3. General configuration

    - - - - - - - - - - - - - - - - - - - - @@ -18625,20 +18855,10 @@

    8.2.3. General configuration

    - - - - - - - - - -
    Table 152. Scope 'pdsinstall'

    sechub.adapter.checkmarx.resilience.badrequest.retry.max

    3

    Amount of retries done when a 400 bad request happened on Checkmarx server

    sechub.adapter.checkmarx.resilience.badrequest.retry.wait

    2000

    Time to wait until retry is done when a 400 bad request happened on Checkmarx server

    sechub.adapter.checkmarx.resilience.servererror.retry.max

    1

    Amount of retries done when a 500 server internal error happened on Checkmarx server

    sechub.adapter.checkmarx.resilience.servererror.retry.wait

    5000

    Time to wait until retry is done when a 500 server internal error happened on Checkmarx server

    sechub.adapter.pds.default.check.timetowait.milliseconds

    30000

    Time in milliseconds when adapter check operation is called next. When -1 value is 60000 minutes

    240

    Time in minutes when adapter result check will automatically time out and adapter stops execution automatically. When -1 timeout is 7200 minutes

    sechub.adapter.pds.resilience.encryption-out-of-sync.retry.max

    3

    Amount of retries done when a PDS encryption out of sync problem happens

    sechub.adapter.pds.resilience.encryption-out-of-sync.retry.wait

    2000

    Time to wait until retry is done when a PDS encryption out of sync problem happens
    - - +
    Table 151. Scope 's'
    +@@ -18653,34 +18873,39 @@

    8.2.3. General configuration

    - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + + + + + +
    Table 153. Scope 'pdsresilience'

    sechub.notification.smtp.config

    mail.smtp.auth=false,mail.transport.protocol=smtp

    SMTP configuration map. You can setup all java mail smtp settings here in comma separate form with key=value. For Example: mail.smtp.auth=false,mail.smtp.timeout=4000. See https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html for configuration mapping

    sechub.adapter.checkmarx.resilience.badrequest.retry.max

    3

    Amount of retries done when a 400 bad request happened on Checkmarx server

    sechub.notification.smtp.credential.password

    Password on SMPTP server, empty value means no password

    sechub.adapter.checkmarx.resilience.badrequest.retry.wait

    2000

    Time to wait until retry is done when a 400 bad request happened on Checkmarx server

    sechub.notification.smtp.credential.username

    Username on SMPTP server, empty value means no username

    sechub.adapter.checkmarx.resilience.servererror.retry.max

    1

    Amount of retries done when a 500 server internal error happened on Checkmarx server

    sechub.notification.smtp.hostname

    Hostname of SMPTP server

    sechub.adapter.checkmarx.resilience.servererror.retry.wait

    5000

    Time to wait until retry is done when a 500 server internal error happened on Checkmarx server

    sechub.notification.smtp.port

    25

    Port of SMPTP server, per default:25

    sechub.adapter.pds.resilience.encryption-out-of-sync.retry.max

    3

    Amount of retries done when a PDS encryption out of sync problem happens

    sechub.adapter.pds.resilience.encryption-out-of-sync.retry.wait

    2000

    Time to wait until retry is done when a PDS encryption out of sync problem happens
    - +@@ -18717,7 +18942,7 @@

    8.2.3. General configuration

    Table 152. Scope 'scan'Table 154. Scope 'scan'
    - +@@ -18745,7 +18970,7 @@

    8.2.3. General configuration

    Table 153. Scope 'schedule'Table 155. Scope 'schedule'
    - +@@ -18807,7 +19032,7 @@

    8.2.3. General configuration

    Table 154. Scope 'scheduler'Table 156. Scope 'scheduler'
    - +@@ -18874,7 +19099,7 @@

    8.2.3. General configuration

    Table 155. Scope 'sec'Table 157. Scope 'sec'
    - +@@ -18896,7 +19121,7 @@

    8.2.3. General configuration

    Table 156. Scope 'security'Table 158. Scope 'security'
    - +@@ -18917,8 +19142,50 @@

    8.2.3. General configuration

    Table 157. Scope 'server'Table 159. Scope 'server'
    + + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 160. Scope 'smtpserver'
    Key or variable nameDefaultDescription

    sechub.notification.smtp.config

    mail.smtp.auth=false,mail.transport.protocol=smtp

    SMTP configuration map. You can setup all java mail smtp settings here in comma separate form with key=value. For Example: mail.smtp.auth=false,mail.smtp.timeout=4000. See https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html for configuration mapping

    sechub.notification.smtp.credential.password

    Password on SMPTP server, empty value means no password

    sechub.notification.smtp.credential.username

    Username on SMPTP server, empty value means no username

    sechub.notification.smtp.hostname

    Hostname of SMPTP server

    sechub.notification.smtp.port

    25

    Port of SMPTP server, per default:25

    - +@@ -19005,7 +19272,7 @@

    8.2.3. General configuration

    Table 158. Scope 'storage'Table 161. Scope 'storage'
    - +@@ -19037,7 +19304,7 @@

    8.2.3. General configuration

    Table 159. Scope 'system'Table 162. Scope 'system'
    - +@@ -19069,7 +19336,7 @@

    8.2.3. General configuration

    8.2.4. Scheduling definitions

    Table 160. Scope 'target'Table 163. Scope 'target'
    - +@@ -19091,7 +19358,7 @@

    8.2.4. Scheduling definitions

    - +@@ -19113,7 +19380,7 @@

    8.2.4. Scheduling definitions

    Table 162. Scope 'scan'Table 165. Scope 'scan'
    - +@@ -19148,7 +19415,7 @@

    8.2.4. Scheduling definitions

    8.2.5. Configuration properties for mocked adapters

    Table 163. Scope 'schedule'Table 166. Scope 'schedule'
    - +@@ -19170,7 +19437,7 @@

    8.2.5. Configuration properties for mocked adapters

    Table 164. Scope 'abstract'Table 167. Scope 'abstract'
    - +@@ -21821,7 +22088,7 @@

    13. Glossary

    diff --git a/docs/latest/sechub-client.html b/docs/latest/sechub-client.html index 1567d0606..1a348e80d 100644 --- a/docs/latest/sechub-client.html +++ b/docs/latest/sechub-client.html @@ -531,7 +531,7 @@
    Table 165. Scope 'mocked'Table 168. Scope 'mocked'
    -

    Documentation version: Client 1.8.1 modified (commit c39468e) - Build date: 20241021165905

    +

    Documentation version: Client 1.9.0 - Build date: 2024-11-27 09:48 (UTCZ)

    @@ -1137,7 +1137,11 @@
    2.4.3.3. getStatus
    2.4.3.4. getReport
    -

    Will fetch the report as json. (result will only exist when job is done)

    +

    Download the SecHub report. (A result will only exist when the SecHub job has finished)

    +
    +
    +

    You can choose the format with -reportformat <format>. Default is json.
    +Currently supported: json, html, spdx-json(only for license scans). If an unsupported format is provided then json will always be the fallback.

    Minimum call syntax

    @@ -4507,7 +4511,7 @@
    3.1.2.1. Example cod
    diff --git a/docs/latest/sechub-developer-quickstart-guide.html b/docs/latest/sechub-developer-quickstart-guide.html index 43a0c7261..3df11e219 100644 --- a/docs/latest/sechub-developer-quickstart-guide.html +++ b/docs/latest/sechub-developer-quickstart-guide.html @@ -531,7 +531,7 @@
    @@ -2153,7 +2153,7 @@
    5.2.2.3. Run a SecHub + PDS integra diff --git a/docs/latest/sechub-getting-started.html b/docs/latest/sechub-getting-started.html index a9cf341af..768f31c4c 100644 --- a/docs/latest/sechub-getting-started.html +++ b/docs/latest/sechub-getting-started.html @@ -531,7 +531,7 @@ @@ -991,7 +991,7 @@

    5.1. Install SecHub’s VS diff --git a/docs/latest/sechub-operations.html b/docs/latest/sechub-operations.html index ec7366d5b..bddf67e90 100644 --- a/docs/latest/sechub-operations.html +++ b/docs/latest/sechub-operations.html @@ -531,7 +531,7 @@
    -
    $ curl 'https://sechub.example.com/api/admin/scan/download/b3d0fadc-5631-48fe-ad3b-d1d2856e4158' -i -u 'user:secret' -X GET \
+
    $ 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'
    @@ -5088,7 +5093,7 @@

    2.2.20. Admin shows scan logs for pro
    -
    [{"sechubJobUUID":"236cbc48-7499-4aed-9de2-8646de4bf48d","executedBy":"spartakus","started":"2024-10-20T16:59:24.353716812","ended":"2024-10-21T16:59:24.353740156","status":"OK"}]
    +
    [{"sechubJobUUID":"b2a0f621-cbed-431f-816d-f8f5a655e8bc","executedBy":"spartakus","started":"2024-11-26T09:48:46.447108027","ended":"2024-11-27T09:48:46.447126853","status":"OK"}]
    @@ -5465,7 +5470,133 @@

    2.2.23. Admin changes project access
    - +

    2.2.24. get assigned project data

    +
    +

    REST API for usecase UC_081-get assigned project data

    +
    +
    +

    Definition

    +
    + + ++++ + + + + + + + + + + + + + + + + + + + + +
    Table 41. General request information
    Value

    Path

    /api/projects

    Method

    GET

    Status code

    200 OK

    +
    +

    Path parameters

    +
    + + ++++ + + + + + + +
    Table 42. https://localhost:8081/api/projects
    ParameterDescription
    +
    +

    Request headers

    +
    + ++++ + + + + + + +
    NameDescription
    +
    +

    Response fields

    +
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PathTypeDescription

    [].projectId

    String

    Project ID

    [].owner

    String

    Name of owner of the Project

    [].isOwned

    Boolean

    If caller is owner of the project

    [].assignedUsers

    Array

    Optional: Assigned users (only viewable by owner or admin)

    +
    +

    Example

    +
    +
    +

    Curl request

    +
    +
    +
    +
    $ curl 'https://sechub.example.com/api/projects' -i -u 'user:secret' -X GET \
+    -H 'Content-Type: application/json;charset=UTF-8'
    +
    +
    +
    +

    Response body

    +
    +
    +
    +
    [{"projectId":"project1","owner":"user1","assignedUsers":["user1","user2"],"isOwned":true}]
    +
    +
    +
    +
    + @@ -5473,7 +5604,7 @@
    - +@@ -5503,7 +5634,7 @@
    Table 41. General request informationTable 43. General request information
    - +@@ -5539,17 +5670,17 @@
    Table 42. https://localhost:8081/api/anonymous/apitoken/{oneTimeToken}Table 44. https://localhost:8081/api/anonymous/apitoken/{oneTimeToken}
    - +@@ -5579,7 +5710,7 @@
    2.2.25.1. Code Scan variant

    Path parameters

    Table 43. General request informationTable 45. General request information
    - +@@ -5698,17 +5829,17 @@
    2.2.25.1. Code Scan variant
    -
    {"jobId":"e985a705-ffb7-49b1-99e6-1407d27226e4"}
    +
    {"jobId":"7786c4a7-042f-4d2b-8bcf-6c23aabf6e7b"}
    -
    2.2.25.2. Code Scan using data section variant
    +
    2.2.26.2. Code Scan using data section variant

    Definition

    Table 44. https://localhost:8081/api/project/{projectId}/jobTable 46. https://localhost:8081/api/project/{projectId}/job
    - +@@ -5738,7 +5869,7 @@
    2.2.25.2. Code Sc

    Path parameters

    Table 45. General request informationTable 47. General request information
    - +@@ -5877,17 +6008,17 @@
    2.2.25.2. Code Sc
    -
    {"jobId":"2210eb32-7fd0-4299-b75b-0d87a5db26a0"}
    +
    {"jobId":"35ea98be-9e36-4cc6-8c8a-3a157d24ead7"}
    -
    2.2.25.3. Secret scan variant
    +
    2.2.26.3. Secret scan variant

    Definition

    Table 46. https://localhost:8081/api/project/{projectId}/jobTable 48. https://localhost:8081/api/project/{projectId}/job
    - +@@ -5917,7 +6048,7 @@
    2.2.25.3. Secret scan variant

    Path parameters

    Table 47. General request informationTable 49. General request information
    - +@@ -6036,17 +6167,17 @@
    2.2.25.3. Secret scan variant
    -
    {"jobId":"a0e2dc56-54fa-4b25-b1e6-688dd47baaf4"}
    +
    {"jobId":"dc364126-fdc7-40a8-b8e7-ff087eb22bf2"}
    -
    2.2.25.4. License scan variant
    +
    2.2.26.4. License scan variant

    Definition

    Table 48. https://localhost:8081/api/project/{projectId}/jobTable 50. https://localhost:8081/api/project/{projectId}/job
    - +@@ -6076,7 +6207,7 @@
    2.2.25.4. License scan variantPath parameters

    Table 49. General request informationTable 51. General request information
    - +@@ -6195,17 +6326,17 @@
    2.2.25.4. License scan variant
    -
    {"jobId":"e7c1d895-bc81-4c70-92ad-7ca117bab44a"}
    +
    {"jobId":"7ff1f27b-bae9-4593-b4ee-5a5df3e52604"}
    -
    2.2.25.5. Infrastructure scan variant
    +
    2.2.26.5. Infrastructure scan variant

    Definition

    Table 50. https://localhost:8081/api/project/{projectId}/jobTable 52. https://localhost:8081/api/project/{projectId}/job
    - +@@ -6235,7 +6366,7 @@
    2.2.25.5. Infrastructure s

    Path parameters

    Table 51. General request informationTable 53. General request information
    - +@@ -6349,17 +6480,17 @@
    2.2.25.5. Infrastructure s
    -
    {"jobId":"953dff35-71f1-4983-b360-0762a95ca7c0"}
    +
    {"jobId":"fcf8cb7f-4f7c-413a-9978-ce8a085fbc7f"}
    -
    2.2.25.6. Web scan anonymous variant
    +
    2.2.26.6. Web scan anonymous variant

    Definition

    Table 52. https://localhost:8081/api/project/{projectId}/jobTable 54. https://localhost:8081/api/project/{projectId}/job
    - +@@ -6389,7 +6520,7 @@
    2.2.25.6. Web scan anonymou

    Path parameters

    Table 53. General request informationTable 55. General request information
    - +@@ -6518,17 +6649,17 @@
    2.2.25.6. Web scan anonymou
    -
    {"jobId":"9bb88784-b24d-436e-898a-40e9e9c9d42b"}
    +
    {"jobId":"42566c19-7464-4f4a-95e6-79e722ae39b7"}
    -
    2.2.25.7. Web scan with api definition variant
    +
    2.2.26.7. Web scan with api definition variant

    Definition

    Table 54. https://localhost:8081/api/project/{projectId}/jobTable 56. https://localhost:8081/api/project/{projectId}/job
    - +@@ -6558,7 +6689,7 @@
    2.2.25.7. Web sca

    Path parameters

    Table 55. General request informationTable 57. General request information
    - +@@ -6682,17 +6813,17 @@
    2.2.25.7. Web sca
    -
    {"jobId":"39b31e69-97ca-4543-99a6-50c4f6cc075b"}
    +
    {"jobId":"1ad5cd3b-5a1e-4a7e-8b07-8d5bd87dd515"}
    -
    2.2.25.8. Web scan with client certificate definition variant
    +
    2.2.26.8. Web scan with client certificate definition variant

    Definition

    Table 56. https://localhost:8081/api/project/{projectId}/jobTable 58. https://localhost:8081/api/project/{projectId}/job
    - +@@ -6722,7 +6853,7 @@
    2.

    Path parameters

    Table 57. General request informationTable 59. General request information
    - +@@ -6841,17 +6972,17 @@
    2.
    -
    {"jobId":"df9ee013-ee60-45bb-929a-1f2bb410f153"}
    +
    {"jobId":"019ef25e-a21a-4c9e-9412-2ec55887f291"}
    -
    2.2.25.9. Web Scan login basic variant
    +
    2.2.26.9. Web Scan login basic variant

    Definition

    Table 58. https://localhost:8081/api/project/{projectId}/jobTable 60. https://localhost:8081/api/project/{projectId}/job
    - +@@ -6881,7 +7012,7 @@
    2.2.25.9. Web Scan login

    Path parameters

    Table 59. General request informationTable 61. General request information
    - +@@ -7015,17 +7146,17 @@
    2.2.25.9. Web Scan login
    -
    {"jobId":"57628d15-8dd2-4b28-b9fa-42e0c6037c43"}
    +
    {"jobId":"b7960f36-3dcd-4030-a4d1-fa8ba4f99462"}
    -
    2.2.25.10. Web Scan login form scripted variant
    +
    2.2.26.10. Web Scan login form scripted variant

    Definition

    Table 60. https://localhost:8081/api/project/{projectId}/jobTable 62. https://localhost:8081/api/project/{projectId}/job
    - +@@ -7055,7 +7186,7 @@
    2.2.25.10. Web Sc

    Path parameters

    Table 61. General request informationTable 63. General request information
    - +@@ -7234,17 +7365,17 @@
    2.2.25.10. Web Sc
    -
    {"jobId":"d47f3a92-0951-4447-8300-fad04567f65b"}
    +
    {"jobId":"d70e8d78-f3c9-4d16-a57f-9f4957e4723a"}
    -
    2.2.25.11. Web Scan headers variant
    +
    2.2.26.11. Web Scan headers variant

    Definition

    Table 62. https://localhost:8081/api/project/{projectId}/jobTable 64. https://localhost:8081/api/project/{projectId}/job
    - +@@ -7274,7 +7405,7 @@
    2.2.25.11. Web Scan headers v

    Path parameters

    Table 63. General request informationTable 65. General request information
    - +@@ -7398,13 +7529,13 @@
    2.2.25.11. Web Scan headers v
    -
    {"jobId":"37527d26-9792-44ae-a2c8-36dfb67fe36c"}
    +
    {"jobId":"67515a5b-1f33-4d6b-b432-1ed5ba525ee0"}
    -

    2.2.26. User uploads source code

    +

    2.2.27. User uploads source code

    REST API for usecase UC_006-User uploads source code

    @@ -7412,7 +7543,7 @@

    2.2.26. User uploads source code

    Definition

    Table 64. https://localhost:8081/api/project/{projectId}/jobTable 66. https://localhost:8081/api/project/{projectId}/job
    - +@@ -7442,7 +7573,7 @@

    2.2.26. User uploads source code

    Path parameters

    Table 65. General request informationTable 67. General request information
    - +@@ -7465,6 +7596,27 @@

    2.2.26. User uploads source code

    Table 66. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/sourcecodeTable 68. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/sourcecode
    +

    Query parameters

    +
    + ++++ + + + + + + + + + + + + +
    ParameterDescription

    checkSum

    A sha256 checksum for file upload validation

    +

    Request headers

    @@ -7487,7 +7639,7 @@

    2.2.26. User uploads source code

    -
    $ curl 'https://sechub.example.com/api/project/project1/job/dc48eaff-3a7d-414f-82f6-f242dcd9bf74/sourcecode?checkSum=checkSumValue' -i -X POST \
+
    $ 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 @@ 
    2.2.26. User uploads source code
    -

    2.2.27. User approves sechub job

    +

    2.2.28. User approves sechub job

    REST API for usecase UC_007-User approves sechub job

    @@ -7509,7 +7661,7 @@

    2.2.27. User approves sechub job

    Definition

    - +@@ -7539,7 +7691,7 @@

    2.2.27. User approves sechub job

    Path parameters

    Table 67. General request informationTable 69. General request information
    - +@@ -7584,7 +7736,7 @@

    2.2.27. User approves sechub job

    -
    $ curl 'https://sechub.example.com/api/project/project1/job/bb20198d-8bb8-4ff5-961c-4fc6ecddd80d/approve' -i -X PUT \
+
    $ 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'
    @@ -7594,7 +7746,7 @@

    2.2.27. User approves sechub job

    -

    2.2.28. User checks sechub job state

    +

    2.2.29. User checks sechub job state

    @@ -7602,7 +7754,7 @@

    2.2.28. User checks sechub job state

    Definition

    Table 68. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/approveTable 70. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/approve
    - +@@ -7632,7 +7784,7 @@

    2.2.28. User checks sechub job state

    Path parameters

    Table 69. General request informationTable 71. General request information
    - +@@ -7736,7 +7888,7 @@

    2.2.28. User checks sechub job state

    -
    $ curl 'https://sechub.example.com/api/project/project1/job/abb3751f-2ca5-4f0c-bae1-04a0e1788550' -i -X GET \
+
    $ 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'
    @@ -7745,22 +7897,22 @@

    2.2.28. User checks sechub job state

    -
    {"jobUUID":"abb3751f-2ca5-4f0c-bae1-04a0e1788550","owner":"CREATOR1","created":"","started":"2024-10-21T16:44:22.764797265","ended":"2024-10-21T16:59:22.764824576","state":"ENDED","result":"OK","trafficLight":"GREEN"}
    +
    {"jobUUID":"92179639-e089-4894-a4df-14f1e40e453d","owner":"CREATOR1","created":"","started":"2024-11-27T09:33:44.986322732","ended":"2024-11-27T09:48:44.986349833","state":"ENDED","result":"OK","trafficLight":"GREEN"}
    -

    2.2.29. User downloads sechub job report

    +

    2.2.30. User downloads sechub job report

    -
    2.2.29.1. JSON variant
    +
    2.2.30.1. JSON variant

    Definition

    Table 70. https://localhost:8081/api/project/{projectId}/job/{jobUUID}Table 72. https://localhost:8081/api/project/{projectId}/job/{jobUUID}
    - +@@ -7790,7 +7942,7 @@
    2.2.29.1. JSON variant

    Path parameters

    Table 71. General request informationTable 73. General request information
    - +@@ -7820,19 +7972,19 @@
    2.2.29.1. JSON variant
    -
    $ curl 'https://sechub.example.com/api/project/project1/report/7a8b89cc-f4dd-44ac-bae6-212bc2dd01d0' -i -u 'user:secret' -X GET \
+
    $ 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'
    -
    2.2.29.2. HTML variant
    +
    2.2.30.2. HTML variant

    Definition

    Table 72. https://localhost:8081/api/project/{projectId}/report/{jobUUID}Table 74. https://localhost:8081/api/project/{projectId}/report/{jobUUID}
    - +@@ -7862,7 +8014,7 @@
    2.2.29.2. HTML variant

    Path parameters

    Table 73. General request informationTable 75. General request information
    - +@@ -7892,7 +8044,7 @@
    2.2.29.2. HTML variant
    -
    $ curl 'https://sechub.example.com/api/project/project1/report/6f4f16d2-8e58-4ed3-b41c-110b74370d7c' -i -u 'user:secret' -X GET \
+
    $ 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'
    @@ -7900,7 +8052,7 @@
    2.2.29.2. HTML variant
    -

    2.2.30. User marks false positives

    +

    2.2.31. User marks false positives

    @@ -7908,7 +8060,7 @@

    2.2.30. User marks false positives

    Definition

    Table 74. https://localhost:8081/api/project/{projectId}/report/{jobUUID}Table 76. https://localhost:8081/api/project/{projectId}/report/{jobUUID}
    - +@@ -7938,7 +8090,7 @@

    2.2.30. User marks false positives

    Path parameters

    Table 75. General request informationTable 77. General request information
    - +@@ -8074,7 +8226,7 @@

    2.2.30. User marks false positives

    -

    2.2.31. User unmarks existing false positive definitons

    +

    2.2.32. User unmarks existing false positive definitons

    @@ -8082,7 +8234,7 @@

    2.2.31. User unmarks ex

    Definition

    Table 76. https://localhost:8081/api/project/{projectId}/false-positivesTable 78. https://localhost:8081/api/project/{projectId}/false-positives
    - +@@ -8112,7 +8264,7 @@

    2.2.31. User unmarks ex

    Path parameters

    Table 77. General request informationTable 79. General request information
    - +@@ -8170,7 +8322,7 @@

    2.2.31. User unmarks ex
    -

    2.2.32. User fetches false positive configuration of project

    +

    2.2.33. User fetches false positive configuration of project

    @@ -8178,7 +8330,7 @@

    2.2.32. User fetch

    Definition

    Table 78. https://localhost:8081/api/project/{projectId}/false-positive/{jobUUID}/{findingId}Table 80. https://localhost:8081/api/project/{projectId}/false-positive/{jobUUID}/{findingId}
    - +@@ -8208,7 +8360,7 @@

    2.2.32. User fetch

    Path parameters

    Table 79. General request informationTable 81. General request information
    - +@@ -8431,7 +8583,7 @@

    2.2.32. User fetch
    -

    2.2.33. User uploads binaries

    +

    2.2.34. User uploads binaries

    REST API for usecase UC_069-User uploads binaries

    @@ -8439,7 +8591,7 @@

    2.2.33. User uploads binaries

    Definition

    Table 80. https://localhost:8081/api/project/{projectId}/false-positivesTable 82. https://localhost:8081/api/project/{projectId}/false-positives
    - +@@ -8469,7 +8621,7 @@

    2.2.33. User uploads binaries

    Path parameters

    Table 81. General request informationTable 83. General request information
    - +@@ -8520,7 +8672,7 @@

    2.2.33. User uploads binaries

    -
    $ curl 'https://sechub.example.com/api/project/project1/job/b8b8b952-dadf-44b7-9480-c0276657f991/binaries' -i -X POST \
+
    $ 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 @@ 
    2.2.33. User uploads binaries
    -

    2.2.34. User downloads job report in SPDX format

    +

    2.2.35. User downloads job report in SPDX format

    @@ -8541,7 +8693,7 @@

    2.2.34. User downloads job rep

    Definition

    Table 82. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/binariesTable 84. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/binaries
    - +@@ -8571,7 +8723,7 @@

    2.2.34. User downloads job rep

    Path parameters

    Table 83. General request informationTable 85. General request information
    - +@@ -8601,14 +8753,14 @@

    2.2.34. User downloads job rep
    -
    $ curl 'https://sechub.example.com/api/project/project1/report/spdx/4f730441-ec48-4a4f-ad1d-e57932c4d802' -i -u 'user:secret' -X GET \
+
    $ 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'
    -

    2.2.35. User unmarks existing false positive project data definitons

    +

    2.2.36. User unmarks existing false positive project data definitons

    @@ -8616,7 +8768,7 @@

    2.2.35. Us

    Definition

    Table 84. https://localhost:8081/api/project/{projectId}/report/spdx/{jobUUID}Table 86. https://localhost:8081/api/project/{projectId}/report/spdx/{jobUUID}
    - +@@ -8646,7 +8798,7 @@

    2.2.35. Us

    Path parameters

    Table 85. General request informationTable 87. General request information
    - +@@ -8700,7 +8852,7 @@

    2.2.35. Us
    -

    2.2.36. User self registration

    +

    2.2.37. User self registration

    REST API for usecase UC_001-User self registration

    @@ -8708,7 +8860,7 @@

    2.2.36. User self registration

    Definition

    Table 86. https://localhost:8081/api/project/{projectId}/false-positive/project-data/{id}Table 88. https://localhost:8081/api/project/{projectId}/false-positive/project-data/{id}
    - +@@ -8787,7 +8939,7 @@

    2.2.36. User self registration

    -

    2.2.37. Admin lists open user signups

    +

    2.2.38. Admin lists open user signups

    @@ -8795,7 +8947,7 @@

    2.2.37. Admin lists open user signups

    Definition

    Table 87. General request informationTable 89. General request information
    - +@@ -8891,7 +9043,7 @@

    2.2.37. Admin lists open user signups

    -

    2.2.38. Admin applies self registration

    +

    2.2.39. Admin applies self registration

    @@ -8899,7 +9051,7 @@

    2.2.38. Admin applies self registration

    Definition

    Table 88. General request informationTable 90. General request information
    - +@@ -8929,7 +9081,7 @@

    2.2.38. Admin applies self registration

    Path parameters

    Table 89. General request informationTable 91. General request information
    - +@@ -8979,7 +9131,7 @@

    2.2.38. Admin applies self registration
    -

    2.2.39. Admin deletes user signup

    +

    2.2.40. Admin deletes user signup

    REST API for usecase UC_019-Admin deletes user signup

    @@ -8987,7 +9139,7 @@

    2.2.39. Admin deletes user signup

    Definition

    Table 90. https://localhost:8081/api/admin/signup/accept/{userId}Table 92. https://localhost:8081/api/admin/signup/accept/{userId}
    - +@@ -9017,7 +9169,7 @@

    2.2.39. Admin deletes user signup

    Path parameters

    Table 91. General request informationTable 93. General request information
    - +@@ -9067,7 +9219,7 @@

    2.2.39. Admin deletes user signup

    -

    2.2.40. User requests new API token

    +

    2.2.41. User requests new API token

    @@ -9075,7 +9227,7 @@

    2.2.40. User requests new API token

    Definition

    Table 92. https://localhost:8081/api/admin/signup/{userId}Table 94. https://localhost:8081/api/admin/signup/{userId}
    - +@@ -9105,7 +9257,7 @@

    2.2.40. User requests new API token

    Path parameters

    Table 93. General request informationTable 95. General request information
    - +@@ -9141,7 +9293,7 @@

    2.2.40. User requests new API token

    -

    2.2.41. Admin lists all running jobs

    +

    2.2.42. Admin lists all running jobs

    @@ -9149,7 +9301,7 @@

    2.2.41. Admin lists all running jobs

    Definition

    Table 94. https://localhost:8081/api/anonymous/refresh/apitoken/{emailAddress}Table 96. https://localhost:8081/api/anonymous/refresh/apitoken/{emailAddress}
    - +@@ -9251,12 +9403,12 @@

    2.2.41. Admin lists all running jobs

    -
    [{"jobUUID":"aa8cee6d-756f-414d-8134-3159bdd75f44","projectId":"project-name","owner":"owner-userid","status":"RUNNING","since":"2024-10-21T16:59:27.703658282"}]
    +
    [{"jobUUID":"a8503241-c02c-4722-afce-7a54eb0e7ea0","projectId":"project-name","owner":"owner-userid","status":"RUNNING","since":"2024-11-27T09:48:49.769371918"}]
    -

    2.2.42. Admin cancels a job

    +

    2.2.43. Admin cancels a job

    REST API for usecase UC_034-Admin cancels a job

    @@ -9264,7 +9416,7 @@

    2.2.42. Admin cancels a job

    Definition

    Table 95. General request informationTable 97. General request information
    - +@@ -9294,7 +9446,7 @@

    2.2.42. Admin cancels a job

    Path parameters

    Table 96. General request informationTable 98. General request information
    - +@@ -9335,7 +9487,7 @@

    2.2.42. Admin cancels a job

    -
    $ curl 'https://sechub.example.com/api/admin/jobs/cancel/92f9bfd4-051b-455b-b7b8-ffc1f6db45f6' -i -u 'user:secret' -X POST \
+
    $ 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'
    @@ -9345,7 +9497,7 @@

    2.2.42. Admin cancels a job

    -

    2.2.43. Admin restarts a job

    +

    2.2.44. Admin restarts a job

    REST API for usecase UC_041-Admin restarts a job

    @@ -9353,7 +9505,7 @@

    2.2.43. Admin restarts a job

    Definition

    Table 97. https://localhost:8081/api/admin/jobs/cancel/{jobUUID}Table 99. https://localhost:8081/api/admin/jobs/cancel/{jobUUID}
    - +@@ -9383,7 +9535,7 @@

    2.2.43. Admin restarts a job

    Path parameters

    Table 98. General request informationTable 100. General request information
    - +@@ -9424,7 +9576,7 @@

    2.2.43. Admin restarts a job

    -
    $ curl 'https://sechub.example.com/api/admin/jobs/restart/be57747a-0731-4a35-ab3a-722e4f454077' -i -u 'user:secret' -X POST \
+
    $ 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'
    @@ -9434,7 +9586,7 @@

    2.2.43. Admin restarts a job

    -

    2.2.44. Admin restarts a job (hard)

    +

    2.2.45. Admin restarts a job (hard)

    @@ -9442,7 +9594,7 @@

    2.2.44. Admin restarts a job (hard)

    Definition

    Table 99. https://localhost:8081/api/admin/jobs/restart/{jobUUID}Table 101. https://localhost:8081/api/admin/jobs/restart/{jobUUID}
    - +@@ -9472,7 +9624,7 @@

    2.2.44. Admin restarts a job (hard)

    Path parameters

    Table 100. General request informationTable 102. General request information
    - +@@ -9513,7 +9665,7 @@

    2.2.44. Admin restarts a job (hard)

    -
    $ curl 'https://sechub.example.com/api/admin/jobs/restart-hard/c9aea17c-1fe0-4c11-b1c5-fe21aa3ec9bb' -i -u 'user:secret' -X POST \
+
    $ 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'
    @@ -9523,7 +9675,7 @@

    2.2.44. Admin restarts a job (hard)

    -

    2.2.45. User defines mock data configuration for project

    +

    2.2.46. User defines mock data configuration for project

    @@ -9531,7 +9683,7 @@

    2.2.45. User defines m

    Definition

    Table 101. https://localhost:8081/api/admin/jobs/restart-hard/{jobUUID}Table 103. https://localhost:8081/api/admin/jobs/restart-hard/{jobUUID}
    - +@@ -9592,7 +9744,7 @@

    2.2.45. User defines m
    -

    2.2.46. User retrieves mock data configuration for project

    +

    2.2.47. User retrieves mock data configuration for project

    @@ -9600,7 +9752,7 @@

    2.2.46. User retriev

    Definition

    Table 102. General request informationTable 104. General request information
    - +@@ -9664,7 +9816,7 @@

    2.2.46. User retriev
    -

    2.2.47. Admin updates mapping configuration

    +

    2.2.48. Admin updates mapping configuration

    @@ -9672,7 +9824,7 @@

    2.2.47. Admin updates mapping confi

    Definition

    Table 103. General request informationTable 105. General request information
    - +@@ -9702,7 +9854,7 @@

    2.2.47. Admin updates mapping confi

    Path parameters

    Table 104. General request informationTable 106. General request information
    - +@@ -9788,7 +9940,7 @@

    2.2.47. Admin updates mapping confi
    -

    2.2.48. Admin fetches mapping configuration

    +

    2.2.49. Admin fetches mapping configuration

    @@ -9796,7 +9948,7 @@

    2.2.48. Admin fetches mapping confi

    Definition

    Table 105. https://localhost:8081/api/admin/config/mapping/{mappingId}Table 107. https://localhost:8081/api/admin/config/mapping/{mappingId}
    - +@@ -9826,7 +9978,7 @@

    2.2.48. Admin fetches mapping confi

    Path parameters

    Table 106. General request informationTable 108. General request information
    - +@@ -9915,7 +10067,7 @@

    2.2.48. Admin fetches mapping confi
    -

    2.2.49. Admin creates an executor configuration

    +

    2.2.50. Admin creates an executor configuration

    @@ -9923,7 +10075,7 @@

    2.2.49. Admin creates an execut

    Definition

    Table 107. https://localhost:8081/api/admin/config/mapping/{mappingId}Table 109. https://localhost:8081/api/admin/config/mapping/{mappingId}
    - +@@ -10046,12 +10198,12 @@

    2.2.49. Admin creates an execut
    -
    85aa1ed2-4c62-41e0-90b8-5aaccda85f11
    +
    b922b3e7-3416-4d74-8b1a-81fbe61a3f63
    -

    2.2.50. Admin deletes executor configuration

    +

    2.2.51. Admin deletes executor configuration

    @@ -10059,7 +10211,7 @@

    2.2.50. Admin deletes executor con

    Definition

    Table 108. General request informationTable 110. General request information
    - +@@ -10089,7 +10241,7 @@

    2.2.50. Admin deletes executor con

    Path parameters

    Table 109. General request informationTable 111. General request information
    - +@@ -10130,7 +10282,7 @@

    2.2.50. Admin deletes executor con
    -
    $ curl 'https://sechub.example.com/api/admin/config/executor/01252350-78be-4eed-8103-d4c8dadcb1d5' -i -u 'user:secret' -X DELETE \
+
    $ 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'
    @@ -10140,7 +10292,7 @@

    2.2.50. Admin deletes executor con
    -

    2.2.51. Admin fetches executor configuration list

    +

    2.2.52. Admin fetches executor configuration list

    @@ -10148,7 +10300,7 @@

    2.2.51. Admin fetches executo

    Definition

    Table 110. https://localhost:8081/api/admin/config/executor/{uuid}Table 112. https://localhost:8081/api/admin/config/executor/{uuid}
    - +@@ -10245,12 +10397,12 @@

    2.2.51. Admin fetches executo
    -
    {"executorConfigurations":[{"uuid":"decbe618-fb22-42fd-ad28-9a98d629f981","name":"example configuration","enabled":true}],"type":"executorConfigurationList"}
    +
    {"executorConfigurations":[{"uuid":"fd85ad57-94c1-4671-a1ea-100fcb679201","name":"example configuration","enabled":true}],"type":"executorConfigurationList"}
    -

    2.2.52. Admin fetches executor configuration

    +

    2.2.53. Admin fetches executor configuration

    @@ -10258,7 +10410,7 @@

    2.2.52. Admin fetches executor con

    Definition

    Table 111. General request informationTable 113. General request information
    - +@@ -10288,7 +10440,7 @@

    2.2.52. Admin fetches executor con

    Path parameters

    Table 112. General request informationTable 114. General request information
    - +@@ -10398,7 +10550,7 @@

    2.2.52. Admin fetches executor con
    -
    $ curl 'https://sechub.example.com/api/admin/config/executor/d3da4fff-26ac-424d-a207-4653dbff9ca8' -i -u 'user:secret' -X GET \
+
    $ 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'
    @@ -10407,12 +10559,12 @@

    2.2.52. Admin fetches executor con
    -
    {"uuid":"d3da4fff-26ac-424d-a207-4653dbff9ca8","name":"New name","productIdentifier":"PDS_CODESCAN","setup":{"baseURL":"https://product.example.com","credentials":{"user":"env:EXAMPLE_USENAME","password":"env:EXAMPLE_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value"}]},"executorVersion":1,"enabled":false}
    +
    {"uuid":"cf306d66-846b-4bc2-a66e-5b60055aaa70","name":"New name","productIdentifier":"PDS_CODESCAN","setup":{"baseURL":"https://product.example.com","credentials":{"user":"env:EXAMPLE_USENAME","password":"env:EXAMPLE_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value"}]},"executorVersion":1,"enabled":false}
    -

    2.2.53. Admin updates executor configuration setup

    +

    2.2.54. Admin updates executor configuration setup

    @@ -10420,7 +10572,7 @@

    2.2.53. Admin updates execut

    Definition

    Table 113. https://localhost:8081/api/admin/config/executor/{uuid}Table 115. https://localhost:8081/api/admin/config/executor/{uuid}
    - +@@ -10450,7 +10602,7 @@

    2.2.53. Admin updates execut

    Path parameters

    Table 114. General request informationTable 116. General request information
    - +@@ -10555,7 +10707,7 @@

    2.2.53. Admin updates execut
    -
    $ curl 'https://sechub.example.com/api/admin/config/executor/150289d5-3831-4eac-80ed-337c2ff30949' -i -u 'user:secret' -X PUT \
+
    $ 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"}]}}'
    @@ -10566,7 +10718,7 @@

    2.2.53. Admin updates execut

    -

    2.2.54. Admin creates an execution profile

    +

    2.2.55. Admin creates an execution profile

    @@ -10574,7 +10726,7 @@

    2.2.54. Admin creates an execution p

    Definition

    Table 115. https://localhost:8081/api/admin/config/executor/{uuid}Table 117. https://localhost:8081/api/admin/config/executor/{uuid}
    - +@@ -10604,7 +10756,7 @@

    2.2.54. Admin creates an execution p

    Path parameters

    Table 116. General request informationTable 118. General request information
    - +@@ -10695,7 +10847,7 @@

    2.2.54. Admin creates an execution p
    -

    2.2.55. Admin deletes execution profile

    +

    2.2.56. Admin deletes execution profile

    @@ -10703,7 +10855,7 @@

    2.2.55. Admin deletes execution profile

    Definition

    Table 117. https://localhost:8081/api/admin/config/execution/profile/{profileId}Table 119. https://localhost:8081/api/admin/config/execution/profile/{profileId}
    - +@@ -10733,7 +10885,7 @@

    2.2.55. Admin deletes execution profile

    Path parameters

    Table 118. General request informationTable 120. General request information
    - +@@ -10784,7 +10936,7 @@

    2.2.55. Admin deletes execution profile
    -

    2.2.56. Admin updates execution profile

    +

    2.2.57. Admin updates execution profile

    @@ -10792,7 +10944,7 @@

    2.2.56. Admin updates execution profile

    Definition

    Table 119. https://localhost:8081/api/admin/config/execution/profile/{profileId}Table 121. https://localhost:8081/api/admin/config/execution/profile/{profileId}
    - +@@ -10822,7 +10974,7 @@

    2.2.56. Admin updates execution profile

    Path parameters

    Table 120. General request informationTable 122. General request information
    - +@@ -10899,7 +11051,7 @@

    2.2.56. Admin updates execution profile 
    $ 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}'
    + -d '{"description":"changed description","configurations":[{"uuid":"5a8e548a-169d-4642-8d2d-00bed1357847","executorVersion":0,"enabled":false,"setup":{"credentials":{},"jobParameters":[]}}],"enabled":true}'
    @@ -10908,7 +11060,7 @@

    2.2.56. Admin updates execution profile

    -

    2.2.57. Admin fetches execution profile

    +

    2.2.58. Admin fetches execution profile

    @@ -10916,7 +11068,7 @@

    2.2.57. Admin fetches execution profile

    Definition

    Table 121. https://localhost:8081/api/admin/config/execution/profile/{profileId}Table 123. https://localhost:8081/api/admin/config/execution/profile/{profileId}
    - +@@ -10946,7 +11098,7 @@

    2.2.57. Admin fetches execution profile

    Path parameters

    Table 122. General request informationTable 124. General request information
    - +@@ -11055,12 +11207,12 @@

    2.2.57. Admin fetches execution profile
    -
    {"description":"a description","enabled":true,"configurations":[{"uuid":"f8dd3854-ae30-450a-828a-1b715bcd57d3","name":"New name","productIdentifier":"PDS_CODESCAN","setup":{"baseURL":"https://product.example.com","credentials":{"user":"env:EXAMPLE_USENAME","password":"env:EXAMPLE_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value but changed. Remark: the other parameter (example.key2) has been removed by this call"}]},"executorVersion":1,"enabled":false}],"projectIds":["project-1","project-2"]}
    +
    {"description":"a description","enabled":true,"configurations":[{"uuid":"006a3f33-85f6-4586-a509-5ef17c40004b","name":"New name","productIdentifier":"PDS_CODESCAN","setup":{"baseURL":"https://product.example.com","credentials":{"user":"env:EXAMPLE_USENAME","password":"env:EXAMPLE_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value but changed. Remark: the other parameter (example.key2) has been removed by this call"}]},"executorVersion":1,"enabled":false}],"projectIds":["project-1","project-2"]}
    -

    2.2.58. Admin fetches execution profile list

    +

    2.2.59. Admin fetches execution profile list

    @@ -11068,7 +11220,7 @@

    2.2.58. Admin fetches execution pr

    Definition

    Table 123. https://localhost:8081/api/admin/config/execution/profile/{profileId}Table 125. https://localhost:8081/api/admin/config/execution/profile/{profileId}
    - +@@ -11170,7 +11322,7 @@

    2.2.58. Admin fetches execution pr
    -

    2.2.59. Admin assigns execution profile to project

    +

    2.2.60. Admin assigns execution profile to project

    @@ -11178,7 +11330,7 @@

    2.2.59. Admin assigns execut

    Definition

    Table 124. General request informationTable 126. General request information
    - +@@ -11208,7 +11360,7 @@

    2.2.59. Admin assigns execut

    Path parameters

    Table 125. General request informationTable 127. General request information
    - +@@ -11263,7 +11415,7 @@

    2.2.59. Admin assigns execut
    -

    2.2.60. Admin unassigns execution profile from project

    +

    2.2.61. Admin unassigns execution profile from project

    @@ -11271,7 +11423,7 @@

    2.2.60. Admin unassigns

    Definition

    Table 126. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}Table 128. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}
    - +@@ -11301,7 +11453,7 @@

    2.2.60. Admin unassigns

    Path parameters

    Table 127. General request informationTable 129. General request information
    - +@@ -11356,7 +11508,7 @@

    2.2.60. Admin unassigns
    -

    2.2.61. Admin fetches auto cleanup configuration

    +

    2.2.62. Admin fetches auto cleanup configuration

    @@ -11364,7 +11516,7 @@

    2.2.61. Admin fetches auto cle

    Definition

    Table 128. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}Table 130. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}
    - +@@ -11427,7 +11579,7 @@

    2.2.61. Admin fetches auto cle
    -

    2.2.62. Admin updates auto cleanup configuration

    +

    2.2.63. Admin updates auto cleanup configuration

    @@ -11435,7 +11587,7 @@

    2.2.62. Admin updates auto cle

    Definition

    Table 129. General request informationTable 131. General request information
    - +@@ -11495,7 +11647,7 @@

    2.2.62. Admin updates auto cle
    -

    2.2.63. Admin starts encryption rotation

    +

    2.2.64. Admin starts encryption rotation

    @@ -11503,7 +11655,7 @@

    2.2.63. Admin starts encryption rotati

    Definition

    Table 130. General request informationTable 132. General request information
    - +@@ -11567,7 +11719,7 @@

    2.2.63. Admin starts encryption rotati
    -

    2.2.64. Admin fetches encryption status

    +

    2.2.65. Admin fetches encryption status

    @@ -11575,7 +11727,7 @@

    2.2.64. Admin fetches encryption status

    Definition

    Table 131. General request informationTable 133. General request information
    - +@@ -11707,7 +11859,7 @@

    2.2.64. Admin fetches encryption status
    -

    2.2.65. Admin disables job processing in scheduler

    +

    2.2.66. Admin disables job processing in scheduler

    @@ -11715,7 +11867,7 @@

    2.2.65. Admin disables job p

    Definition

    Table 132. General request informationTable 134. General request information
    - +@@ -11774,7 +11926,7 @@

    2.2.65. Admin disables job p
    -

    2.2.66. Admin enables scheduler job processing

    +

    2.2.67. Admin enables scheduler job processing

    @@ -11782,7 +11934,7 @@

    2.2.66. Admin enables scheduler

    Definition

    Table 133. General request informationTable 135. General request information
    - +@@ -11841,7 +11993,7 @@

    2.2.66. Admin enables scheduler
    -

    2.2.67. Admin get scheduler status

    +

    2.2.68. Admin get scheduler status

    @@ -11849,7 +12001,7 @@

    2.2.67. Admin get scheduler status

    Definition

    Table 134. General request informationTable 136. General request information
    - +@@ -11908,7 +12060,7 @@

    2.2.67. Admin get scheduler status

    -

    2.2.68. Admin lists status information

    +

    2.2.69. Admin lists status information

    @@ -11916,7 +12068,7 @@

    2.2.68. Admin lists status informationDefinition

    Table 135. General request informationTable 137. General request information
    - +@@ -12008,7 +12160,7 @@

    2.2.68. Admin lists status information
    -

    2.2.69. Admin fetches server runtime data

    +

    2.2.70. Admin fetches server runtime data

    @@ -12016,7 +12168,7 @@

    2.2.69. Admin fetches server runtime

    Definition

    Table 136. General request informationTable 138. General request information
    - +@@ -12088,7 +12240,7 @@

    2.2.69. Admin fetches server runtime
    -

    2.2.70. User lists jobs for project

    +

    2.2.71. User lists jobs for project

    @@ -12096,7 +12248,7 @@

    2.2.70. User lists jobs for project

    Definition

    Table 137. General request informationTable 139. General request information
    - +@@ -12126,7 +12278,7 @@

    2.2.70. User lists jobs for project

    Path parameters

    Table 138. General request informationTable 140. General request information
    - +@@ -12145,6 +12297,41 @@

    2.2.70. User lists jobs for project

    Table 139. https://localhost:8081/api/project/{projectId}/jobsTable 141. https://localhost:8081/api/project/{projectId}/jobs
    +

    Query parameters

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterDescription

    size

    The wanted (maximum) size for the result set. When not defined, the default will be 1.

    page

    The wanted page number. When not defined, the default will be 0.

    metadata.labels.*

    An optional dynamic query parameter to filter jobs by labels. The syntax is 'metadata.labels.${labelKey}=${labelValue}'.

    +

    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.

    withMetaData

    An optional parameter to define if meta data shall be fetched as well. When not defined, the default will be false.

    +

    Request headers

    @@ -12250,7 +12437,7 @@

    2.2.70. User lists jobs for project

    -
    {"page":0,"totalPages":1,"content":[{"jobUUID":"4fc54538-9eab-4eb5-9da4-9d1cc0897760","executedBy":"User1","created":"2024-10-21T16:42:22.956477277","started":"2024-10-21T16:44:22.956508736","ended":"2024-10-21T16:59:22.956525658","executionState":"ENDED","trafficLight":"GREEN","executionResult":"OK","metaData":{"labels":{"stage":"test"}}}]}
    +
    {"page":0,"totalPages":1,"content":[{"jobUUID":"8d080df1-24cd-470f-b8bd-845baf4b7d60","executedBy":"User1","created":"2024-11-27T09:31:45.196835109","started":"2024-11-27T09:33:45.196866799","ended":"2024-11-27T09:48:45.19687809","executionState":"ENDED","trafficLight":"GREEN","executionResult":"OK","metaData":{"labels":{"stage":"test"}}}]}
    @@ -12603,6 +12790,9 @@
    4.1.1.3. Project administration

  • UC_062-Admin changes project access level

    • +
  • +

    UC_081-get assigned project data

    +
    • @@ -17706,10 +17896,70 @@

    4.1.81. UC_080-System resumes suspended jobs

    + +
    +

    4.1.82. UC_081-get assigned project data

    +
    +

    User, Owner or Admin fetches a list containing information about assigned and/ or owned projects.

    +
    +
    +

    The Project data contains the following information:

    +
    +
    +
      +
    • +

      Project ID

      +
      • +
    • +

      Owner

      +
      • +
    • +

      is owned

      +
      • +
    • +

      assigned users (can only be viewed by owner or admin)

      +
      • +
    +
    +
    +

    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.

    +
    +
    +

    Steps

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NrTitleRole(s)NextDescription

    1

    Rest API call to get Projects with information

    OWNER, SUPERADMIN, USER

    Rest api call to get projects with details

    -
    4.1.81.1. Overview
    +
    4.1.82.1. Overview
    -
    4.1.81.1.1. Diagram
    +
    4.1.82.1.1. Diagram
    Sequence diagram of messaging overview @@ -17717,7 +17967,7 @@
    4.1.81.1.1. Diagram
    - +
    • @@ -17896,7 +18146,7 @@
    -
    4.1.81.2. Message ANALYZE_SCAN_RESULTS_AVAILABLE
    +
    4.1.82.2. Message ANALYZE_SCAN_RESULTS_AVAILABLE
    Sequence diagram of messaging ANALYZE_SCAN_RESULTS_AVAILABLE @@ -17904,7 +18154,7 @@
    4.1.81.2. Message
    -
    4.1.81.3. Message AUTO_CLEANUP_CONFIGURATION_CHANGED
    +
    4.1.82.3. Message AUTO_CLEANUP_CONFIGURATION_CHANGED
    Sequence diagram of messaging AUTO_CLEANUP_CONFIGURATION_CHANGED @@ -17933,7 +18183,7 @@
    4.1.81.3. Mess
    -
    4.1.81.4. Message BINARY_UPLOAD_DONE
    +
    4.1.82.4. Message BINARY_UPLOAD_DONE
    Sequence diagram of messaging BINARY_UPLOAD_DONE @@ -17941,7 +18191,7 @@
    4.1.81.4. Message BINARY_UPLOA
    -
    4.1.81.5. Message GET_ENCRYPTION_STATUS_SCHEDULE_DOMAIN
    +
    4.1.82.5. Message GET_ENCRYPTION_STATUS_SCHEDULE_DOMAIN
    Sequence diagram of messaging GET_ENCRYPTION_STATUS_SCHEDULE_DOMAIN @@ -17949,7 +18199,7 @@
    4.1.81.5. M
    -
    4.1.81.6. Message JOB_CANCELLATION_RUNNING
    +
    4.1.82.6. Message JOB_CANCELLATION_RUNNING
    Sequence diagram of messaging JOB_CANCELLATION_RUNNING @@ -17957,7 +18207,7 @@
    4.1.81.6. Message JOB_CA
    -
    4.1.81.7. Message JOB_CREATED
    +
    4.1.82.7. Message JOB_CREATED
    Sequence diagram of messaging JOB_CREATED @@ -17965,7 +18215,7 @@
    4.1.81.7. Message JOB_CREATED
    -
    4.1.81.8. Message JOB_DONE
    +
    4.1.82.8. Message JOB_DONE
    Sequence diagram of messaging JOB_DONE @@ -17997,7 +18247,7 @@
    4.1.81.8. Message JOB_DONE
    -
    4.1.81.9. Message JOB_EXECUTION_STARTING
    +
    4.1.82.9. Message JOB_EXECUTION_STARTING
    Sequence diagram of messaging JOB_EXECUTION_STARTING @@ -18029,7 +18279,7 @@
    4.1.81.9. Message JOB_EXEC
    -
    4.1.81.10. Message JOB_FAILED
    +
    4.1.82.10. Message JOB_FAILED
    Sequence diagram of messaging JOB_FAILED @@ -18037,7 +18287,7 @@
    4.1.81.10. Message JOB_FAILED
    -
    4.1.81.11. Message JOB_RESTART_CANCELED
    +
    4.1.82.11. Message JOB_RESTART_CANCELED
    Sequence diagram of messaging JOB_RESTART_CANCELED @@ -18069,7 +18319,7 @@
    4.1.81.11. Message JOB_RESTA
    -
    4.1.81.12. Message JOB_RESTART_TRIGGERED
    +
    4.1.82.12. Message JOB_RESTART_TRIGGERED
    Sequence diagram of messaging JOB_RESTART_TRIGGERED @@ -18101,7 +18351,7 @@
    4.1.81.12. Message JOB_REST
    -
    4.1.81.13. Message JOB_RESULTS_PURGED
    +
    4.1.82.13. Message JOB_RESULTS_PURGED
    Sequence diagram of messaging JOB_RESULTS_PURGED @@ -18130,7 +18380,7 @@
    4.1.81.13. Message JOB_RESULTS
    -
    4.1.81.14. Message JOB_RESULT_PURGE_DONE
    +
    4.1.82.14. Message JOB_RESULT_PURGE_DONE
    Sequence diagram of messaging JOB_RESULT_PURGE_DONE @@ -18138,7 +18388,7 @@
    4.1.81.14. Message JOB_RESU
    -
    4.1.81.15. Message JOB_RESULT_PURGE_FAILED
    +
    4.1.82.15. Message JOB_RESULT_PURGE_FAILED
    Sequence diagram of messaging JOB_RESULT_PURGE_FAILED @@ -18146,7 +18396,7 @@
    4.1.81.15. Message JOB_RE
    -
    4.1.81.16. Message JOB_STARTED
    +
    4.1.82.16. Message JOB_STARTED
    Sequence diagram of messaging JOB_STARTED @@ -18178,7 +18428,7 @@
    4.1.81.16. Message JOB_STARTED
    -
    4.1.81.17. Message JOB_SUSPENDED
    +
    4.1.82.17. Message JOB_SUSPENDED
    Sequence diagram of messaging JOB_SUSPENDED @@ -18186,7 +18436,7 @@
    4.1.81.17. Message JOB_SUSPENDED
    -
    4.1.81.18. Message MAPPING_CONFIGURATION_CHANGED
    +
    4.1.82.18. Message MAPPING_CONFIGURATION_CHANGED
    Sequence diagram of messaging MAPPING_CONFIGURATION_CHANGED @@ -18194,7 +18444,7 @@
    4.1.81.18. Message
    -
    4.1.81.19. Message PRODUCT_EXECUTOR_CANCEL_OPERATIONS_DONE
    +
    4.1.82.19. Message PRODUCT_EXECUTOR_CANCEL_OPERATIONS_DONE
    Sequence diagram of messaging PRODUCT_EXECUTOR_CANCEL_OPERATIONS_DONE @@ -18202,7 +18452,7 @@
    4.1.81.19
    -
    4.1.81.20. Message PROJECT_ACCESS_LEVEL_CHANGED
    +
    4.1.82.20. Message PROJECT_ACCESS_LEVEL_CHANGED
    Sequence diagram of messaging PROJECT_ACCESS_LEVEL_CHANGED @@ -18210,7 +18460,7 @@
    4.1.81.20. Message P
    -
    4.1.81.21. Message PROJECT_CREATED
    +
    4.1.82.21. Message PROJECT_CREATED
    Sequence diagram of messaging PROJECT_CREATED @@ -18218,7 +18468,7 @@
    4.1.81.21. Message PROJECT_CREATE
    -
    4.1.81.22. Message PROJECT_DELETED
    +
    4.1.82.22. Message PROJECT_DELETED
    Sequence diagram of messaging PROJECT_DELETED @@ -18226,7 +18476,7 @@
    4.1.81.22. Message PROJECT_DELETE
    -
    4.1.81.23. Message PROJECT_OWNER_CHANGED
    +
    4.1.82.23. Message PROJECT_OWNER_CHANGED
    Sequence diagram of messaging PROJECT_OWNER_CHANGED @@ -18234,7 +18484,7 @@
    4.1.81.23. Message PROJECT_
    -
    4.1.81.24. Message PROJECT_WHITELIST_UPDATED
    +
    4.1.82.24. Message PROJECT_WHITELIST_UPDATED
    Sequence diagram of messaging PROJECT_WHITELIST_UPDATED @@ -18242,7 +18492,7 @@
    4.1.81.24. Message PROJ
    -
    4.1.81.25. Message REQUEST_JOB_CANCELLATION
    +
    4.1.82.25. Message REQUEST_JOB_CANCELLATION
    Sequence diagram of messaging REQUEST_JOB_CANCELLATION @@ -18250,7 +18500,7 @@
    4.1.81.25. Message REQUE
    -
    4.1.81.26. Message REQUEST_JOB_RESTART
    +
    4.1.82.26. Message REQUEST_JOB_RESTART
    Sequence diagram of messaging REQUEST_JOB_RESTART @@ -18279,7 +18529,7 @@
    4.1.81.26. Message REQUEST_JO
    -
    4.1.81.27. Message REQUEST_JOB_RESTART_HARD
    +
    4.1.82.27. Message REQUEST_JOB_RESTART_HARD
    Sequence diagram of messaging REQUEST_JOB_RESTART_HARD @@ -18308,7 +18558,7 @@
    4.1.81.27. Message REQUE
    -
    4.1.81.28. Message REQUEST_PURGE_JOB_RESULTS
    +
    4.1.82.28. Message REQUEST_PURGE_JOB_RESULTS
    Sequence diagram of messaging REQUEST_PURGE_JOB_RESULTS @@ -18337,7 +18587,7 @@
    4.1.81.28. Message REQU
    -
    4.1.81.29. Message REQUEST_SCHEDULER_DISABLE_JOB_PROCESSING
    +
    4.1.82.29. Message REQUEST_SCHEDULER_DISABLE_JOB_PROCESSING
    Sequence diagram of messaging REQUEST_SCHEDULER_DISABLE_JOB_PROCESSING @@ -18366,7 +18616,7 @@
    4.1.81.2
    -
    4.1.81.30. Message REQUEST_SCHEDULER_ENABLE_JOB_PROCESSING
    +
    4.1.82.30. Message REQUEST_SCHEDULER_ENABLE_JOB_PROCESSING
    Sequence diagram of messaging REQUEST_SCHEDULER_ENABLE_JOB_PROCESSING @@ -18395,7 +18645,7 @@
    4.1.81.30
    -
    4.1.81.31. Message REQUEST_SCHEDULER_JOB_STATUS
    +
    4.1.82.31. Message REQUEST_SCHEDULER_JOB_STATUS
    Sequence diagram of messaging REQUEST_SCHEDULER_JOB_STATUS @@ -18427,7 +18677,7 @@
    4.1.81.31. Message R
    -
    4.1.81.32. Message REQUEST_SCHEDULER_STATUS_UPDATE
    +
    4.1.82.32. Message REQUEST_SCHEDULER_STATUS_UPDATE
    Sequence diagram of messaging REQUEST_SCHEDULER_STATUS_UPDATE @@ -18435,7 +18685,7 @@
    4.1.81.32. Messag
    -
    4.1.81.33. Message REQUEST_USER_ROLE_RECALCULATION
    +
    4.1.82.33. Message REQUEST_USER_ROLE_RECALCULATION
    Sequence diagram of messaging REQUEST_USER_ROLE_RECALCULATION @@ -18470,7 +18720,7 @@
    4.1.81.33. Messag
    -
    4.1.81.34. Message RESULT_ENCRYPTION_STATUS_SCHEDULE_DOMAIN
    +
    4.1.82.34. Message RESULT_ENCRYPTION_STATUS_SCHEDULE_DOMAIN
    Sequence diagram of messaging RESULT_ENCRYPTION_STATUS_SCHEDULE_DOMAIN @@ -18478,7 +18728,7 @@
    4.1.81.3
    -
    4.1.81.35. Message SCAN_DONE
    +
    4.1.82.35. Message SCAN_DONE
    Sequence diagram of messaging SCAN_DONE @@ -18486,7 +18736,7 @@
    4.1.81.35. Message SCAN_DONE
    -
    4.1.81.36. Message SCAN_FAILED
    +
    4.1.82.36. Message SCAN_FAILED
    Sequence diagram of messaging SCAN_FAILED @@ -18494,7 +18744,7 @@
    4.1.81.36. Message SCAN_FAILED
    -
    4.1.81.37. Message SCAN_SUSPENDED
    +
    4.1.82.37. Message SCAN_SUSPENDED
    Sequence diagram of messaging SCAN_SUSPENDED @@ -18502,7 +18752,7 @@
    4.1.81.37. Message SCAN_SUSPENDED<
    -
    4.1.81.38. Message SCHEDULER_JOB_PROCESSING_DISABLED
    +
    4.1.82.38. Message SCHEDULER_JOB_PROCESSING_DISABLED
    Sequence diagram of messaging SCHEDULER_JOB_PROCESSING_DISABLED @@ -18531,7 +18781,7 @@
    4.1.81.38. Mess
    -
    4.1.81.39. Message SCHEDULER_JOB_PROCESSING_ENABLED
    +
    4.1.82.39. Message SCHEDULER_JOB_PROCESSING_ENABLED
    Sequence diagram of messaging SCHEDULER_JOB_PROCESSING_ENABLED @@ -18560,7 +18810,7 @@
    4.1.81.39. Messa
    -
    4.1.81.40. Message SCHEDULER_JOB_STATUS
    +
    4.1.82.40. Message SCHEDULER_JOB_STATUS
    Sequence diagram of messaging SCHEDULER_JOB_STATUS @@ -18568,7 +18818,7 @@
    4.1.81.40. Message SCHEDULER
    -
    4.1.81.41. Message SCHEDULER_STARTED
    +
    4.1.82.41. Message SCHEDULER_STARTED
    Sequence diagram of messaging SCHEDULER_STARTED @@ -18576,7 +18826,7 @@
    4.1.81.41. Message SCHEDULER_ST
    -
    4.1.81.42. Message SCHEDULER_STATUS_UPDATE
    +
    4.1.82.42. Message SCHEDULER_STATUS_UPDATE
    Sequence diagram of messaging SCHEDULER_STATUS_UPDATE @@ -18584,7 +18834,7 @@
    4.1.81.42. Message SCHEDU
    -
    4.1.81.43. Message SCHEDULE_ENCRYPTION_POOL_INITIALIZED
    +
    4.1.82.43. Message SCHEDULE_ENCRYPTION_POOL_INITIALIZED
    Sequence diagram of messaging SCHEDULE_ENCRYPTION_POOL_INITIALIZED @@ -18592,7 +18842,7 @@
    4.1.81.43. M
    -
    4.1.81.44. Message SOURCE_UPLOAD_DONE
    +
    4.1.82.44. Message SOURCE_UPLOAD_DONE
    Sequence diagram of messaging SOURCE_UPLOAD_DONE @@ -18600,7 +18850,7 @@
    4.1.81.44. Message SOURCE_UPLO
    -
    4.1.81.45. Message START_ENCRYPTION_ROTATION
    +
    4.1.82.45. Message START_ENCRYPTION_ROTATION
    Sequence diagram of messaging START_ENCRYPTION_ROTATION @@ -18608,7 +18858,7 @@
    4.1.81.45. Message STAR
    -
    4.1.81.46. Message START_SCAN
    +
    4.1.82.46. Message START_SCAN
    Sequence diagram of messaging START_SCAN @@ -18640,7 +18890,7 @@
    4.1.81.46. Message START_SCAN
    -
    4.1.81.47. Message UNSUPPORTED_OPERATION
    +
    4.1.82.47. Message UNSUPPORTED_OPERATION
    Sequence diagram of messaging UNSUPPORTED_OPERATION @@ -18648,7 +18898,7 @@
    4.1.81.47. Message UNSUPPOR
    -
    4.1.81.48. Message USER_ADDED_TO_PROJECT
    +
    4.1.82.48. Message USER_ADDED_TO_PROJECT
    Sequence diagram of messaging USER_ADDED_TO_PROJECT @@ -18677,7 +18927,7 @@
    4.1.81.48. Message USER_ADD
    -
    4.1.81.49. Message USER_API_TOKEN_CHANGED
    +
    4.1.82.49. Message USER_API_TOKEN_CHANGED
    Sequence diagram of messaging USER_API_TOKEN_CHANGED @@ -18685,7 +18935,7 @@
    4.1.81.49. Message USER_AP
    -
    4.1.81.50. Message USER_BECOMES_SUPERADMIN
    +
    4.1.82.50. Message USER_BECOMES_SUPERADMIN
    Sequence diagram of messaging USER_BECOMES_SUPERADMIN @@ -18693,7 +18943,7 @@
    4.1.81.50. Message USER_B
    -
    4.1.81.51. Message USER_CREATED
    +
    4.1.82.51. Message USER_CREATED
    Sequence diagram of messaging USER_CREATED @@ -18722,7 +18972,7 @@
    4.1.81.51. Message USER_CREATED
    -
    4.1.81.52. Message USER_DELETED
    +
    4.1.82.52. Message USER_DELETED
    Sequence diagram of messaging USER_DELETED @@ -18730,7 +18980,7 @@
    4.1.81.52. Message USER_DELETED
    -
    4.1.81.53. Message USER_EMAIL_ADDRESS_CHANGED
    +
    4.1.82.53. Message USER_EMAIL_ADDRESS_CHANGED
    Sequence diagram of messaging USER_EMAIL_ADDRESS_CHANGED @@ -18738,7 +18988,7 @@
    4.1.81.53. Message USE
    -
    4.1.81.54. Message USER_NEW_API_TOKEN_REQUESTED
    +
    4.1.82.54. Message USER_NEW_API_TOKEN_REQUESTED
    Sequence diagram of messaging USER_NEW_API_TOKEN_REQUESTED @@ -18767,7 +19017,7 @@
    4.1.81.54. Message U
    -
    4.1.81.55. Message USER_NO_LONGER_SUPERADMIN
    +
    4.1.82.55. Message USER_NO_LONGER_SUPERADMIN
    Sequence diagram of messaging USER_NO_LONGER_SUPERADMIN @@ -18775,7 +19025,7 @@
    4.1.81.55. Message USER
    -
    4.1.81.56. Message USER_REMOVED_FROM_PROJECT
    +
    4.1.82.56. Message USER_REMOVED_FROM_PROJECT
    Sequence diagram of messaging USER_REMOVED_FROM_PROJECT @@ -18804,7 +19054,7 @@
    4.1.81.56. Message USER
    -
    4.1.81.57. Message USER_ROLES_CHANGED
    +
    4.1.82.57. Message USER_ROLES_CHANGED
    Sequence diagram of messaging USER_ROLES_CHANGED @@ -18839,7 +19089,7 @@
    4.1.81.57. Message USER_ROLES_
    -
    4.1.81.58. Message USER_SIGNUP_REQUESTED
    +
    4.1.82.58. Message USER_SIGNUP_REQUESTED
    Sequence diagram of messaging USER_SIGNUP_REQUESTED @@ -18874,7 +19124,7 @@
    4.1.81.58. Message USER_SIG
    diff --git a/docs/latest/sechub-techdoc.html b/docs/latest/sechub-techdoc.html index ce0ec9d5a..1be57292f 100644 --- a/docs/latest/sechub-techdoc.html +++ b/docs/latest/sechub-techdoc.html @@ -531,7 +531,7 @@ +
    +

    10.19.82. UC_081-get assigned project data

    +
    +

    User, Owner or Admin fetches a list containing information about assigned and/ or owned projects.

    +
    +
    +

    The Project data contains the following information:

    +
    +
    +
      +
    • +

      Project ID

      +
      • +
    • +

      Owner

      +
      • +
    • +

      is owned

      +
      • +
    • +

      assigned users (can only be viewed by owner or admin)

      +
      • +
    +
    +
    +

    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.

    +
    +
    +

    Technical information

    +
    +
    +

    You will find relevant code parts by searching for references of @com.mercedesbenz.sechub.sharedkernel.project.UseCaseGetAssignedProjectDataList

    +
    +
    +

    Steps

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NrTitleRole(s)NextDescription

    1

    Rest API call to get Projects with information

    OWNER, SUPERADMIN, USER

    Rest api call to get projects with details

    +

    This step is defined at method getAssignedProjectDataList in class `com.mercedesbenz.sechub.domain.administration.project.ProjectRestController`

    +
    +

    REST API documentation for usecase UC_081-get assigned project data

    +
    +

    10.20. Domain driven design

    @@ -15744,7 +15837,7 @@
    11.2.3.1. PDS
    are listed here for the sake of completeness.

    - +@@ -16668,6 +16761,9 @@
    12.1.1.3. Project administration

  • REST API for UC_062-Admin changes project access level

    • +
  • +

    REST API for UC_081-get assigned project data

    +
    • @@ -16904,7 +17000,7 @@
    12.1.2.1. HEAD variant

    Definition

    Table 27. PDS executor configuration parametersTable 28. PDS executor configuration parameters
    - +@@ -16952,7 +17048,7 @@
    12.1.2.2. GET variant

    Definition

    Table 28. General request informationTable 29. General request information
    - +@@ -17004,7 +17100,7 @@

    12.1.3. Admin lists all users

    Definition

    Table 29. General request informationTable 30. General request information
    - +@@ -17083,7 +17179,7 @@

    12.1.4. Admin assigns user to project

    Definition

    Table 30. General request informationTable 31. General request information
    - +@@ -17113,7 +17209,7 @@

    12.1.4. Admin assigns user to project

    Path parameters

    Table 31. General request informationTable 32. General request information
    - +@@ -17176,7 +17272,7 @@

    12.1.5. Admin unassigns user from pro

    Definition

    Table 32. https://localhost:8081/api/admin/project/{projectId}/membership/{userId}Table 33. https://localhost:8081/api/admin/project/{projectId}/membership/{userId}
    - +@@ -17206,7 +17302,7 @@

    12.1.5. Admin unassigns user from pro

    Path parameters

    Table 33. General request informationTable 34. General request information
    - +@@ -17269,7 +17365,7 @@

    12.1.6. Admin shows user details

    Definition

    Table 34. https://localhost:8081/api/admin/project/{projectId}/membership/{userId}Table 35. https://localhost:8081/api/admin/project/{projectId}/membership/{userId}
    - +@@ -17299,7 +17395,7 @@

    12.1.6. Admin shows user details

    Path parameters

    Table 35. General request informationTable 36. General request information
    - +@@ -17405,7 +17501,7 @@

    12.1.7. Admin deletes a user

    Definition

    Table 36. https://localhost:8081/api/admin/user/{userId}Table 37. https://localhost:8081/api/admin/user/{userId}
    - +@@ -17435,7 +17531,7 @@

    12.1.7. Admin deletes a user

    Path parameters

    Table 37. General request informationTable 38. General request information
    - +@@ -17493,7 +17589,7 @@

    12.1.8. Admin shows project details

    Definition

    Table 38. https://localhost:8081/api/admin/user/{userId}Table 39. https://localhost:8081/api/admin/user/{userId}
    - +@@ -17523,7 +17619,7 @@

    12.1.8. Admin shows project details

    Path parameters

    Table 39. General request informationTable 40. General request information
    - +@@ -17645,7 +17741,7 @@

    12.1.9. Admin downloads al

    Definition

    Table 40. https://localhost:8081/api/admin/project/{projectId}Table 41. https://localhost:8081/api/admin/project/{projectId}
    - +@@ -17675,7 +17771,7 @@

    12.1.9. Admin downloads al

    Path parameters

    Table 41. General request informationTable 42. General request information
    - +@@ -17701,7 +17797,7 @@

    12.1.9. Admin downloads al
    -
    $ curl 'https://sechub.example.com/api/admin/scan/download/b3d0fadc-5631-48fe-ad3b-d1d2856e4158' -i -u 'user:secret' -X GET \
+
    $ 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'
    @@ -17715,7 +17811,7 @@

    12.1.10. Admin grants admin rights to

    Definition

    Table 42. https://localhost:8081/api/admin/scan/download/{jobUUID}Table 43. https://localhost:8081/api/admin/scan/download/{jobUUID}
    - +@@ -17745,7 +17841,7 @@

    12.1.10. Admin grants admin rights to

    Path parameters

    Table 43. General request informationTable 44. General request information
    - +@@ -17803,7 +17899,7 @@

    12.1.11. Admin revokes admin r

    Definition

    Table 44. https://localhost:8081/api/admin/user/{userId}/grant/superadminTable 45. https://localhost:8081/api/admin/user/{userId}/grant/superadmin
    - +@@ -17833,7 +17929,7 @@

    12.1.11. Admin revokes admin r

    Path parameters

    Table 45. General request informationTable 46. General request information
    - +@@ -17891,7 +17987,7 @@

    12.1.12. Admin lists all admins

    Definition

    Table 46. https://localhost:8081/api/admin/user/{userId}/revoke/superadminTable 47. https://localhost:8081/api/admin/user/{userId}/revoke/superadmin
    - +@@ -17985,7 +18081,7 @@

    12.1.13. Admin changes owner of a proj

    Definition

    Table 47. General request informationTable 48. General request information
    - +@@ -18015,7 +18111,7 @@

    12.1.13. Admin changes owner of a proj

    Path parameters

    Table 48. General request informationTable 49. General request information
    - +@@ -18078,7 +18174,7 @@

    12.1.14. Admin updates user email addr

    Definition

    Table 49. https://localhost:8081/api/admin/project/{projectId}/owner/{userId}Table 50. https://localhost:8081/api/admin/project/{projectId}/owner/{userId}
    - +@@ -18108,7 +18204,7 @@

    12.1.14. Admin updates user email addr

    Path parameters

    Table 50. General request informationTable 51. General request information
    - +@@ -18170,7 +18266,7 @@

    12.1.15. Admin shows user de

    Definition

    Table 51. https://localhost:8081/api/admin/user/{userId}/email/{emailAddress}Table 52. https://localhost:8081/api/admin/user/{userId}/email/{emailAddress}
    - +@@ -18200,7 +18296,7 @@

    12.1.15. Admin shows user de

    Path parameters

    Table 52. General request informationTable 53. General request information
    - +@@ -18312,7 +18408,7 @@

    12.1.16. Admin creates a project

    Definition

    Table 53. https://localhost:8081/api/admin/user-by-email/{emailAddress}Table 54. https://localhost:8081/api/admin/user-by-email/{emailAddress}
    - +@@ -18434,7 +18530,7 @@

    12.1.17. Admin lists all projects

    Definition

    Table 54. General request informationTable 55. General request information
    - +@@ -18529,7 +18625,7 @@

    12.1.18. Admin deletes a project

    Definition

    Table 55. General request informationTable 56. General request information
    - +@@ -18559,7 +18655,7 @@

    12.1.18. Admin deletes a project

    Path parameters

    Table 56. General request informationTable 57. General request information
    - +@@ -18618,7 +18714,7 @@

    12.1.19. Update project whitelist

    Definition

    Table 57. https://localhost:8081/api/admin/project/{projectId}Table 58. https://localhost:8081/api/admin/project/{projectId}
    - +@@ -18648,7 +18744,7 @@

    12.1.19. Update project whitelist

    Path parameters

    Table 58. General request informationTable 59. General request information
    - +@@ -18737,7 +18833,7 @@

    12.1.20. Admin shows scan logs for pr

    Definition

    Table 59. https://localhost:8081/api/admin/project/{projectId}/whitelistTable 60. https://localhost:8081/api/admin/project/{projectId}/whitelist
    - +@@ -18767,7 +18863,7 @@

    12.1.20. Admin shows scan logs for pr

    Path parameters

    Table 60. General request informationTable 61. General request information
    - +@@ -18866,7 +18962,7 @@

    12.1.20. Admin shows scan logs for pr
    -
    [{"sechubJobUUID":"236cbc48-7499-4aed-9de2-8646de4bf48d","executedBy":"spartakus","started":"2024-10-20T16:59:24.353716812","ended":"2024-10-21T16:59:24.353740156","status":"OK"}]
    +
    [{"sechubJobUUID":"b2a0f621-cbed-431f-816d-f8f5a655e8bc","executedBy":"spartakus","started":"2024-11-26T09:48:46.447108027","ended":"2024-11-27T09:48:46.447126853","status":"OK"}]
    @@ -18879,7 +18975,7 @@

    12.1.21. Update project metadata

    Definition

    Table 61. https://localhost:8081/api/admin/project/{projectId}/scan/logsTable 62. https://localhost:8081/api/admin/project/{projectId}/scan/logs
    - +@@ -18909,7 +19005,7 @@

    12.1.21. Update project metadata

    Path parameters

    Table 62. General request informationTable 63. General request information
    - +@@ -19003,7 +19099,7 @@

    12.1.22. Admin changes project descri

    Definition

    Table 63. https://localhost:8081/api/admin/project/{projectId}/metadataTable 64. https://localhost:8081/api/admin/project/{projectId}/metadata
    - +@@ -19033,7 +19129,7 @@

    12.1.22. Admin changes project descri

    Path parameters

    Table 64. General request informationTable 65. General request information
    - +@@ -19158,7 +19254,7 @@

    12.1.23. Admin changes project acces

    Definition

    Table 65. https://localhost:8081/api/admin/project/{projectId}Table 66. https://localhost:8081/api/admin/project/{projectId}
    - +@@ -19188,7 +19284,7 @@

    12.1.23. Admin changes project acces

    Path parameters

    Table 66. General request informationTable 67. General request information
    - +@@ -19243,7 +19339,133 @@

    12.1.23. Admin changes project acces
    - +

    12.1.24. get assigned project data

    +
    +

    REST API for usecase UC_081-get assigned project data

    +
    +
    +

    Definition

    +
    +

    Table 67. https://localhost:8081/api/admin/project/{projectId}/accesslevel/{projectAccessLevel}Table 68. https://localhost:8081/api/admin/project/{projectId}/accesslevel/{projectAccessLevel}
    + ++++ + + + + + + + + + + + + + + + + + + + + +
    Table 69. General request information
    Value

    Path

    /api/projects

    Method

    GET

    Status code

    200 OK

    +
    +

    Path parameters

    +
    + + ++++ + + + + + + +
    Table 70. https://localhost:8081/api/projects
    ParameterDescription
    +
    +

    Request headers

    +
    + ++++ + + + + + + +
    NameDescription
    +
    +

    Response fields

    +
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PathTypeDescription

    [].projectId

    String

    Project ID

    [].owner

    String

    Name of owner of the Project

    [].isOwned

    Boolean

    If caller is owner of the project

    [].assignedUsers

    Array

    Optional: Assigned users (only viewable by owner or admin)

    +
    +

    Example

    +
    +
    +

    Curl request

    +
    +
    +
    +
    $ curl 'https://sechub.example.com/api/projects' -i -u 'user:secret' -X GET \
+    -H 'Content-Type: application/json;charset=UTF-8'
    +
    +
    +
    +

    Response body

    +
    +
    +
    +
    [{"projectId":"project1","owner":"user1","assignedUsers":["user1","user2"],"isOwned":true}]
    +
    +
    +
    +
    + @@ -19251,7 +19473,7 @@
    - +@@ -19281,7 +19503,7 @@
    Table 68. General request informationTable 71. General request information
    - +@@ -19317,17 +19539,17 @@
    Table 69. https://localhost:8081/api/anonymous/apitoken/{oneTimeToken}Table 72. https://localhost:8081/api/anonymous/apitoken/{oneTimeToken}
    - +@@ -19357,7 +19579,7 @@
    12.1.25.1. Code Scan variant

    Path parameters

    Table 70. General request informationTable 73. General request information
    - +@@ -19476,17 +19698,17 @@
    12.1.25.1. Code Scan variant
    -
    {"jobId":"e985a705-ffb7-49b1-99e6-1407d27226e4"}
    +
    {"jobId":"7786c4a7-042f-4d2b-8bcf-6c23aabf6e7b"}
    -
    12.1.25.2. Code Scan using data section variant
    +
    12.1.26.2. Code Scan using data section variant

    Definition

    Table 71. https://localhost:8081/api/project/{projectId}/jobTable 74. https://localhost:8081/api/project/{projectId}/job
    - +@@ -19516,7 +19738,7 @@
    12.1.25.2. Code S

    Path parameters

    Table 72. General request informationTable 75. General request information
    - +@@ -19655,17 +19877,17 @@
    12.1.25.2. Code S
    -
    {"jobId":"2210eb32-7fd0-4299-b75b-0d87a5db26a0"}
    +
    {"jobId":"35ea98be-9e36-4cc6-8c8a-3a157d24ead7"}
    -
    12.1.25.3. Secret scan variant
    +
    12.1.26.3. Secret scan variant

    Definition

    Table 73. https://localhost:8081/api/project/{projectId}/jobTable 76. https://localhost:8081/api/project/{projectId}/job
    - +@@ -19695,7 +19917,7 @@
    12.1.25.3. Secret scan variant
    Path parameters

    Table 74. General request informationTable 77. General request information
    - +@@ -19814,17 +20036,17 @@
    12.1.25.3. Secret scan variant
    -
    {"jobId":"a0e2dc56-54fa-4b25-b1e6-688dd47baaf4"}
    +
    {"jobId":"dc364126-fdc7-40a8-b8e7-ff087eb22bf2"}
    -
    12.1.25.4. License scan variant
    +
    12.1.26.4. License scan variant

    Definition

    Table 75. https://localhost:8081/api/project/{projectId}/jobTable 78. https://localhost:8081/api/project/{projectId}/job
    - +@@ -19854,7 +20076,7 @@
    12.1.25.4. License scan variantPath parameters

    Table 76. General request informationTable 79. General request information
    - +@@ -19973,17 +20195,17 @@
    12.1.25.4. License scan variant
    -
    {"jobId":"e7c1d895-bc81-4c70-92ad-7ca117bab44a"}
    +
    {"jobId":"7ff1f27b-bae9-4593-b4ee-5a5df3e52604"}
    -
    12.1.25.5. Infrastructure scan variant
    +
    12.1.26.5. Infrastructure scan variant

    Definition

    Table 77. https://localhost:8081/api/project/{projectId}/jobTable 80. https://localhost:8081/api/project/{projectId}/job
    - +@@ -20013,7 +20235,7 @@
    12.1.25.5. Infrastructure

    Path parameters

    Table 78. General request informationTable 81. General request information
    - +@@ -20127,17 +20349,17 @@
    12.1.25.5. Infrastructure
    -
    {"jobId":"953dff35-71f1-4983-b360-0762a95ca7c0"}
    +
    {"jobId":"fcf8cb7f-4f7c-413a-9978-ce8a085fbc7f"}
    -
    12.1.25.6. Web scan anonymous variant
    +
    12.1.26.6. Web scan anonymous variant

    Definition

    Table 79. https://localhost:8081/api/project/{projectId}/jobTable 82. https://localhost:8081/api/project/{projectId}/job
    - +@@ -20167,7 +20389,7 @@
    12.1.25.6. Web scan anonymo

    Path parameters

    Table 80. General request informationTable 83. General request information
    - +@@ -20296,17 +20518,17 @@
    12.1.25.6. Web scan anonymo
    -
    {"jobId":"9bb88784-b24d-436e-898a-40e9e9c9d42b"}
    +
    {"jobId":"42566c19-7464-4f4a-95e6-79e722ae39b7"}
    -
    12.1.25.7. Web scan with api definition variant
    +
    12.1.26.7. Web scan with api definition variant

    Definition

    Table 81. https://localhost:8081/api/project/{projectId}/jobTable 84. https://localhost:8081/api/project/{projectId}/job
    - +@@ -20336,7 +20558,7 @@
    12.1.25.7. Web sc

    Path parameters

    Table 82. General request informationTable 85. General request information
    - +@@ -20460,17 +20682,17 @@
    12.1.25.7. Web sc
    -
    {"jobId":"39b31e69-97ca-4543-99a6-50c4f6cc075b"}
    +
    {"jobId":"1ad5cd3b-5a1e-4a7e-8b07-8d5bd87dd515"}
    -
    12.1.25.8. Web scan with client certificate definition variant
    +
    12.1.26.8. Web scan with client certificate definition variant

    Definition

    Table 83. https://localhost:8081/api/project/{projectId}/jobTable 86. https://localhost:8081/api/project/{projectId}/job
    - +@@ -20500,7 +20722,7 @@
    12

    Path parameters

    Table 84. General request informationTable 87. General request information
    - +@@ -20619,17 +20841,17 @@
    12
    -
    {"jobId":"df9ee013-ee60-45bb-929a-1f2bb410f153"}
    +
    {"jobId":"019ef25e-a21a-4c9e-9412-2ec55887f291"}
    -
    12.1.25.9. Web Scan login basic variant
    +
    12.1.26.9. Web Scan login basic variant

    Definition

    Table 85. https://localhost:8081/api/project/{projectId}/jobTable 88. https://localhost:8081/api/project/{projectId}/job
    - +@@ -20659,7 +20881,7 @@
    12.1.25.9. Web Scan login

    Path parameters

    Table 86. General request informationTable 89. General request information
    - +@@ -20793,17 +21015,17 @@
    12.1.25.9. Web Scan login
    -
    {"jobId":"57628d15-8dd2-4b28-b9fa-42e0c6037c43"}
    +
    {"jobId":"b7960f36-3dcd-4030-a4d1-fa8ba4f99462"}
    -
    12.1.25.10. Web Scan login form scripted variant
    +
    12.1.26.10. Web Scan login form scripted variant

    Definition

    Table 87. https://localhost:8081/api/project/{projectId}/jobTable 90. https://localhost:8081/api/project/{projectId}/job
    - +@@ -20833,7 +21055,7 @@
    12.1.25.10. Web S

    Path parameters

    Table 88. General request informationTable 91. General request information
    - +@@ -21012,17 +21234,17 @@
    12.1.25.10. Web S
    -
    {"jobId":"d47f3a92-0951-4447-8300-fad04567f65b"}
    +
    {"jobId":"d70e8d78-f3c9-4d16-a57f-9f4957e4723a"}
    -
    12.1.25.11. Web Scan headers variant
    +
    12.1.26.11. Web Scan headers variant

    Definition

    Table 89. https://localhost:8081/api/project/{projectId}/jobTable 92. https://localhost:8081/api/project/{projectId}/job
    - +@@ -21052,7 +21274,7 @@
    12.1.25.11. Web Scan headers

    Path parameters

    Table 90. General request informationTable 93. General request information
    - +@@ -21176,13 +21398,13 @@
    12.1.25.11. Web Scan headers
    -
    {"jobId":"37527d26-9792-44ae-a2c8-36dfb67fe36c"}
    +
    {"jobId":"67515a5b-1f33-4d6b-b432-1ed5ba525ee0"}
    -

    12.1.26. User uploads source code

    +

    12.1.27. User uploads source code

    REST API for usecase UC_006-User uploads source code

    @@ -21190,7 +21412,7 @@

    12.1.26. User uploads source code

    Definition

    Table 91. https://localhost:8081/api/project/{projectId}/jobTable 94. https://localhost:8081/api/project/{projectId}/job
    - +@@ -21220,7 +21442,7 @@

    12.1.26. User uploads source code

    Path parameters

    Table 92. General request informationTable 95. General request information
    - +@@ -21243,6 +21465,27 @@

    12.1.26. User uploads source code

    Table 93. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/sourcecodeTable 96. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/sourcecode
    +

    Query parameters

    +
    + ++++ + + + + + + + + + + + + +
    ParameterDescription

    checkSum

    A sha256 checksum for file upload validation

    +

    Request headers

    @@ -21265,7 +21508,7 @@

    12.1.26. User uploads source code

    -
    $ curl 'https://sechub.example.com/api/project/project1/job/dc48eaff-3a7d-414f-82f6-f242dcd9bf74/sourcecode?checkSum=checkSumValue' -i -X POST \
+
    $ 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 @@ 
    12.1.26. User uploads source code
    -

    12.1.27. User approves sechub job

    +

    12.1.28. User approves sechub job

    REST API for usecase UC_007-User approves sechub job

    @@ -21287,7 +21530,7 @@

    12.1.27. User approves sechub job

    Definition

    - +@@ -21317,7 +21560,7 @@

    12.1.27. User approves sechub job

    Path parameters

    Table 94. General request informationTable 97. General request information
    - +@@ -21362,7 +21605,7 @@

    12.1.27. User approves sechub job

    -
    $ curl 'https://sechub.example.com/api/project/project1/job/bb20198d-8bb8-4ff5-961c-4fc6ecddd80d/approve' -i -X PUT \
+
    $ 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'
    @@ -21372,7 +21615,7 @@

    12.1.27. User approves sechub job

    -

    12.1.28. User checks sechub job state

    +

    12.1.29. User checks sechub job state

    @@ -21380,7 +21623,7 @@

    12.1.28. User checks sechub job state

    Definition

    Table 95. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/approveTable 98. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/approve
    - +@@ -21410,7 +21653,7 @@

    12.1.28. User checks sechub job state

    Path parameters

    Table 96. General request informationTable 99. General request information
    - +@@ -21514,7 +21757,7 @@

    12.1.28. User checks sechub job state

    -
    $ curl 'https://sechub.example.com/api/project/project1/job/abb3751f-2ca5-4f0c-bae1-04a0e1788550' -i -X GET \
+
    $ 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'
    @@ -21523,22 +21766,22 @@

    12.1.28. User checks sechub job state

    -
    {"jobUUID":"abb3751f-2ca5-4f0c-bae1-04a0e1788550","owner":"CREATOR1","created":"","started":"2024-10-21T16:44:22.764797265","ended":"2024-10-21T16:59:22.764824576","state":"ENDED","result":"OK","trafficLight":"GREEN"}
    +
    {"jobUUID":"92179639-e089-4894-a4df-14f1e40e453d","owner":"CREATOR1","created":"","started":"2024-11-27T09:33:44.986322732","ended":"2024-11-27T09:48:44.986349833","state":"ENDED","result":"OK","trafficLight":"GREEN"}
    -

    12.1.29. User downloads sechub job report

    +

    12.1.30. User downloads sechub job report

    -
    12.1.29.1. JSON variant
    +
    12.1.30.1. JSON variant

    Definition

    Table 97. https://localhost:8081/api/project/{projectId}/job/{jobUUID}Table 100. https://localhost:8081/api/project/{projectId}/job/{jobUUID}
    - +@@ -21568,7 +21811,7 @@
    12.1.29.1. JSON variant

    Path parameters

    Table 98. General request informationTable 101. General request information
    - +@@ -21598,19 +21841,19 @@
    12.1.29.1. JSON variant
    -
    $ curl 'https://sechub.example.com/api/project/project1/report/7a8b89cc-f4dd-44ac-bae6-212bc2dd01d0' -i -u 'user:secret' -X GET \
+
    $ 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'
    -
    12.1.29.2. HTML variant
    +
    12.1.30.2. HTML variant

    Definition

    Table 99. https://localhost:8081/api/project/{projectId}/report/{jobUUID}Table 102. https://localhost:8081/api/project/{projectId}/report/{jobUUID}
    - +@@ -21640,7 +21883,7 @@
    12.1.29.2. HTML variant

    Path parameters

    Table 100. General request informationTable 103. General request information
    - +@@ -21670,7 +21913,7 @@
    12.1.29.2. HTML variant
    -
    $ curl 'https://sechub.example.com/api/project/project1/report/6f4f16d2-8e58-4ed3-b41c-110b74370d7c' -i -u 'user:secret' -X GET \
+
    $ 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'
    @@ -21678,7 +21921,7 @@
    12.1.29.2. HTML variant
    -

    12.1.30. User marks false positives

    +

    12.1.31. User marks false positives

    @@ -21686,7 +21929,7 @@

    12.1.30. User marks false positives

    Definition

    Table 101. https://localhost:8081/api/project/{projectId}/report/{jobUUID}Table 104. https://localhost:8081/api/project/{projectId}/report/{jobUUID}
    - +@@ -21716,7 +21959,7 @@

    12.1.30. User marks false positives

    Path parameters

    Table 102. General request informationTable 105. General request information
    - +@@ -21852,7 +22095,7 @@

    12.1.30. User marks false positives

    -

    12.1.31. User unmarks existing false positive definitons

    +

    12.1.32. User unmarks existing false positive definitons

    @@ -21860,7 +22103,7 @@

    12.1.31. User unmarks e

    Definition

    Table 103. https://localhost:8081/api/project/{projectId}/false-positivesTable 106. https://localhost:8081/api/project/{projectId}/false-positives
    - +@@ -21890,7 +22133,7 @@

    12.1.31. User unmarks e

    Path parameters

    Table 104. General request informationTable 107. General request information
    - +@@ -21948,7 +22191,7 @@

    12.1.31. User unmarks e
    -

    12.1.32. User fetches false positive configuration of project

    +

    12.1.33. User fetches false positive configuration of project

    @@ -21956,7 +22199,7 @@

    12.1.32. User fetc

    Definition

    Table 105. https://localhost:8081/api/project/{projectId}/false-positive/{jobUUID}/{findingId}Table 108. https://localhost:8081/api/project/{projectId}/false-positive/{jobUUID}/{findingId}
    - +@@ -21986,7 +22229,7 @@

    12.1.32. User fetc

    Path parameters

    Table 106. General request informationTable 109. General request information
    - +@@ -22209,7 +22452,7 @@

    12.1.32. User fetc
    -

    12.1.33. User uploads binaries

    +

    12.1.34. User uploads binaries

    REST API for usecase UC_069-User uploads binaries

    @@ -22217,7 +22460,7 @@

    12.1.33. User uploads binaries

    Definition

    Table 107. https://localhost:8081/api/project/{projectId}/false-positivesTable 110. https://localhost:8081/api/project/{projectId}/false-positives
    - +@@ -22247,7 +22490,7 @@

    12.1.33. User uploads binaries

    Path parameters

    Table 108. General request informationTable 111. General request information
    - +@@ -22298,7 +22541,7 @@

    12.1.33. User uploads binaries

    -
    $ curl 'https://sechub.example.com/api/project/project1/job/b8b8b952-dadf-44b7-9480-c0276657f991/binaries' -i -X POST \
+
    $ 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 @@ 
    12.1.33. User uploads binaries
    -

    12.1.34. User downloads job report in SPDX format

    +

    12.1.35. User downloads job report in SPDX format

    @@ -22319,7 +22562,7 @@

    12.1.34. User downloads job re

    Definition

    Table 109. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/binariesTable 112. https://localhost:8081/api/project/{projectId}/job/{jobUUID}/binaries
    - +@@ -22349,7 +22592,7 @@

    12.1.34. User downloads job re

    Path parameters

    Table 110. General request informationTable 113. General request information
    - +@@ -22379,14 +22622,14 @@

    12.1.34. User downloads job re
    -
    $ curl 'https://sechub.example.com/api/project/project1/report/spdx/4f730441-ec48-4a4f-ad1d-e57932c4d802' -i -u 'user:secret' -X GET \
+
    $ 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'
    -

    12.1.35. User unmarks existing false positive project data definitons

    +

    12.1.36. User unmarks existing false positive project data definitons

    @@ -22394,7 +22637,7 @@

    12.1.35. U

    Definition

    Table 111. https://localhost:8081/api/project/{projectId}/report/spdx/{jobUUID}Table 114. https://localhost:8081/api/project/{projectId}/report/spdx/{jobUUID}
    - +@@ -22424,7 +22667,7 @@

    12.1.35. U

    Path parameters

    Table 112. General request informationTable 115. General request information
    - +@@ -22478,7 +22721,7 @@

    12.1.35. U
    -

    12.1.36. User self registration

    +

    12.1.37. User self registration

    REST API for usecase UC_001-User self registration

    @@ -22486,7 +22729,7 @@

    12.1.36. User self registration

    Definition

    Table 113. https://localhost:8081/api/project/{projectId}/false-positive/project-data/{id}Table 116. https://localhost:8081/api/project/{projectId}/false-positive/project-data/{id}
    - +@@ -22565,7 +22808,7 @@

    12.1.36. User self registration

    -

    12.1.37. Admin lists open user signups

    +

    12.1.38. Admin lists open user signups

    @@ -22573,7 +22816,7 @@

    12.1.37. Admin lists open user signupsDefinition

    Table 114. General request informationTable 117. General request information
    - +@@ -22669,7 +22912,7 @@

    12.1.37. Admin lists open user signups
    -

    12.1.38. Admin applies self registration

    +

    12.1.39. Admin applies self registration

    @@ -22677,7 +22920,7 @@

    12.1.38. Admin applies self registratio

    Definition

    Table 115. General request informationTable 118. General request information
    - +@@ -22707,7 +22950,7 @@

    12.1.38. Admin applies self registratio

    Path parameters

    Table 116. General request informationTable 119. General request information
    - +@@ -22757,7 +23000,7 @@

    12.1.38. Admin applies self registratio
    -

    12.1.39. Admin deletes user signup

    +

    12.1.40. Admin deletes user signup

    REST API for usecase UC_019-Admin deletes user signup

    @@ -22765,7 +23008,7 @@

    12.1.39. Admin deletes user signup

    Definition

    Table 117. https://localhost:8081/api/admin/signup/accept/{userId}Table 120. https://localhost:8081/api/admin/signup/accept/{userId}
    - +@@ -22795,7 +23038,7 @@

    12.1.39. Admin deletes user signup

    Path parameters

    Table 118. General request informationTable 121. General request information
    - +@@ -22845,7 +23088,7 @@

    12.1.39. Admin deletes user signup

    -

    12.1.40. User requests new API token

    +

    12.1.41. User requests new API token

    @@ -22853,7 +23096,7 @@

    12.1.40. User requests new API token

    Definition

    Table 119. https://localhost:8081/api/admin/signup/{userId}Table 122. https://localhost:8081/api/admin/signup/{userId}
    - +@@ -22883,7 +23126,7 @@

    12.1.40. User requests new API token

    Path parameters

    Table 120. General request informationTable 123. General request information
    - +@@ -22919,7 +23162,7 @@

    12.1.40. User requests new API token

    -

    12.1.41. Admin lists all running jobs

    +

    12.1.42. Admin lists all running jobs

    @@ -22927,7 +23170,7 @@

    12.1.41. Admin lists all running jobs

    Definition

    Table 121. https://localhost:8081/api/anonymous/refresh/apitoken/{emailAddress}Table 124. https://localhost:8081/api/anonymous/refresh/apitoken/{emailAddress}
    - +@@ -23029,12 +23272,12 @@

    12.1.41. Admin lists all running jobs

    -
    [{"jobUUID":"aa8cee6d-756f-414d-8134-3159bdd75f44","projectId":"project-name","owner":"owner-userid","status":"RUNNING","since":"2024-10-21T16:59:27.703658282"}]
    +
    [{"jobUUID":"a8503241-c02c-4722-afce-7a54eb0e7ea0","projectId":"project-name","owner":"owner-userid","status":"RUNNING","since":"2024-11-27T09:48:49.769371918"}]
    -

    12.1.42. Admin cancels a job

    +

    12.1.43. Admin cancels a job

    REST API for usecase UC_034-Admin cancels a job

    @@ -23042,7 +23285,7 @@

    12.1.42. Admin cancels a job

    Definition

    Table 122. General request informationTable 125. General request information
    - +@@ -23072,7 +23315,7 @@

    12.1.42. Admin cancels a job

    Path parameters

    Table 123. General request informationTable 126. General request information
    - +@@ -23113,7 +23356,7 @@

    12.1.42. Admin cancels a job

    -
    $ curl 'https://sechub.example.com/api/admin/jobs/cancel/92f9bfd4-051b-455b-b7b8-ffc1f6db45f6' -i -u 'user:secret' -X POST \
+
    $ 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'
    @@ -23123,7 +23366,7 @@

    12.1.42. Admin cancels a job

    -

    12.1.43. Admin restarts a job

    +

    12.1.44. Admin restarts a job

    REST API for usecase UC_041-Admin restarts a job

    @@ -23131,7 +23374,7 @@

    12.1.43. Admin restarts a job

    Definition

    Table 124. https://localhost:8081/api/admin/jobs/cancel/{jobUUID}Table 127. https://localhost:8081/api/admin/jobs/cancel/{jobUUID}
    - +@@ -23161,7 +23404,7 @@

    12.1.43. Admin restarts a job

    Path parameters

    Table 125. General request informationTable 128. General request information
    - +@@ -23202,7 +23445,7 @@

    12.1.43. Admin restarts a job

    -
    $ curl 'https://sechub.example.com/api/admin/jobs/restart/be57747a-0731-4a35-ab3a-722e4f454077' -i -u 'user:secret' -X POST \
+
    $ 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'
    @@ -23212,7 +23455,7 @@

    12.1.43. Admin restarts a job

    -

    12.1.44. Admin restarts a job (hard)

    +

    12.1.45. Admin restarts a job (hard)

    @@ -23220,7 +23463,7 @@

    12.1.44. Admin restarts a job (hard)

    Definition

    Table 126. https://localhost:8081/api/admin/jobs/restart/{jobUUID}Table 129. https://localhost:8081/api/admin/jobs/restart/{jobUUID}
    - +@@ -23250,7 +23493,7 @@

    12.1.44. Admin restarts a job (hard)

    Path parameters

    Table 127. General request informationTable 130. General request information
    - +@@ -23291,7 +23534,7 @@

    12.1.44. Admin restarts a job (hard)

    -
    $ curl 'https://sechub.example.com/api/admin/jobs/restart-hard/c9aea17c-1fe0-4c11-b1c5-fe21aa3ec9bb' -i -u 'user:secret' -X POST \
+
    $ 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'
    @@ -23301,7 +23544,7 @@

    12.1.44. Admin restarts a job (hard)

    -

    12.1.45. User defines mock data configuration for project

    +

    12.1.46. User defines mock data configuration for project

    @@ -23309,7 +23552,7 @@

    12.1.45. User defines

    Definition

    Table 128. https://localhost:8081/api/admin/jobs/restart-hard/{jobUUID}Table 131. https://localhost:8081/api/admin/jobs/restart-hard/{jobUUID}
    - +@@ -23370,7 +23613,7 @@

    12.1.45. User defines
    -

    12.1.46. User retrieves mock data configuration for project

    +

    12.1.47. User retrieves mock data configuration for project

    @@ -23378,7 +23621,7 @@

    12.1.46. User retrie

    Definition

    Table 129. General request informationTable 132. General request information
    - +@@ -23442,7 +23685,7 @@

    12.1.46. User retrie
    -

    12.1.47. Admin updates mapping configuration

    +

    12.1.48. Admin updates mapping configuration

    @@ -23450,7 +23693,7 @@

    12.1.47. Admin updates mapping conf

    Definition

    Table 130. General request informationTable 133. General request information
    - +@@ -23480,7 +23723,7 @@

    12.1.47. Admin updates mapping conf

    Path parameters

    Table 131. General request informationTable 134. General request information
    - +@@ -23566,7 +23809,7 @@

    12.1.47. Admin updates mapping conf
    -

    12.1.48. Admin fetches mapping configuration

    +

    12.1.49. Admin fetches mapping configuration

    @@ -23574,7 +23817,7 @@

    12.1.48. Admin fetches mapping conf

    Definition

    Table 132. https://localhost:8081/api/admin/config/mapping/{mappingId}Table 135. https://localhost:8081/api/admin/config/mapping/{mappingId}
    - +@@ -23604,7 +23847,7 @@

    12.1.48. Admin fetches mapping conf

    Path parameters

    Table 133. General request informationTable 136. General request information
    - +@@ -23693,7 +23936,7 @@

    12.1.48. Admin fetches mapping conf
    -

    12.1.49. Admin creates an executor configuration

    +

    12.1.50. Admin creates an executor configuration

    @@ -23701,7 +23944,7 @@

    12.1.49. Admin creates an execu

    Definition

    Table 134. https://localhost:8081/api/admin/config/mapping/{mappingId}Table 137. https://localhost:8081/api/admin/config/mapping/{mappingId}
    - +@@ -23824,12 +24067,12 @@

    12.1.49. Admin creates an execu
    -
    85aa1ed2-4c62-41e0-90b8-5aaccda85f11
    +
    b922b3e7-3416-4d74-8b1a-81fbe61a3f63
    -

    12.1.50. Admin deletes executor configuration

    +

    12.1.51. Admin deletes executor configuration

    @@ -23837,7 +24080,7 @@

    12.1.50. Admin deletes executor co

    Definition

    Table 135. General request informationTable 138. General request information
    - +@@ -23867,7 +24110,7 @@

    12.1.50. Admin deletes executor co

    Path parameters

    Table 136. General request informationTable 139. General request information
    - +@@ -23908,7 +24151,7 @@

    12.1.50. Admin deletes executor co
    -
    $ curl 'https://sechub.example.com/api/admin/config/executor/01252350-78be-4eed-8103-d4c8dadcb1d5' -i -u 'user:secret' -X DELETE \
+
    $ 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'
    @@ -23918,7 +24161,7 @@

    12.1.50. Admin deletes executor co
    -

    12.1.51. Admin fetches executor configuration list

    +

    12.1.52. Admin fetches executor configuration list

    @@ -23926,7 +24169,7 @@

    12.1.51. Admin fetches execut

    Definition

    Table 137. https://localhost:8081/api/admin/config/executor/{uuid}Table 140. https://localhost:8081/api/admin/config/executor/{uuid}
    - +@@ -24023,12 +24266,12 @@

    12.1.51. Admin fetches execut
    -
    {"executorConfigurations":[{"uuid":"decbe618-fb22-42fd-ad28-9a98d629f981","name":"example configuration","enabled":true}],"type":"executorConfigurationList"}
    +
    {"executorConfigurations":[{"uuid":"fd85ad57-94c1-4671-a1ea-100fcb679201","name":"example configuration","enabled":true}],"type":"executorConfigurationList"}
    -

    12.1.52. Admin fetches executor configuration

    +

    12.1.53. Admin fetches executor configuration

    @@ -24036,7 +24279,7 @@

    12.1.52. Admin fetches executor co

    Definition

    Table 138. General request informationTable 141. General request information
    - +@@ -24066,7 +24309,7 @@

    12.1.52. Admin fetches executor co

    Path parameters

    Table 139. General request informationTable 142. General request information
    - +@@ -24176,7 +24419,7 @@

    12.1.52. Admin fetches executor co
    -
    $ curl 'https://sechub.example.com/api/admin/config/executor/d3da4fff-26ac-424d-a207-4653dbff9ca8' -i -u 'user:secret' -X GET \
+
    $ 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'
    @@ -24185,12 +24428,12 @@

    12.1.52. Admin fetches executor co
    -
    {"uuid":"d3da4fff-26ac-424d-a207-4653dbff9ca8","name":"New name","productIdentifier":"PDS_CODESCAN","setup":{"baseURL":"https://product.example.com","credentials":{"user":"env:EXAMPLE_USENAME","password":"env:EXAMPLE_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value"}]},"executorVersion":1,"enabled":false}
    +
    {"uuid":"cf306d66-846b-4bc2-a66e-5b60055aaa70","name":"New name","productIdentifier":"PDS_CODESCAN","setup":{"baseURL":"https://product.example.com","credentials":{"user":"env:EXAMPLE_USENAME","password":"env:EXAMPLE_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value"}]},"executorVersion":1,"enabled":false}
    -

    12.1.53. Admin updates executor configuration setup

    +

    12.1.54. Admin updates executor configuration setup

    @@ -24198,7 +24441,7 @@

    12.1.53. Admin updates execu

    Definition

    Table 140. https://localhost:8081/api/admin/config/executor/{uuid}Table 143. https://localhost:8081/api/admin/config/executor/{uuid}
    - +@@ -24228,7 +24471,7 @@

    12.1.53. Admin updates execu

    Path parameters

    Table 141. General request informationTable 144. General request information
    - +@@ -24333,7 +24576,7 @@

    12.1.53. Admin updates execu
    -
    $ curl 'https://sechub.example.com/api/admin/config/executor/150289d5-3831-4eac-80ed-337c2ff30949' -i -u 'user:secret' -X PUT \
+
    $ 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"}]}}'
    @@ -24344,7 +24587,7 @@

    12.1.53. Admin updates execu

    -

    12.1.54. Admin creates an execution profile

    +

    12.1.55. Admin creates an execution profile

    @@ -24352,7 +24595,7 @@

    12.1.54. Admin creates an execution

    Definition

    Table 142. https://localhost:8081/api/admin/config/executor/{uuid}Table 145. https://localhost:8081/api/admin/config/executor/{uuid}
    - +@@ -24382,7 +24625,7 @@

    12.1.54. Admin creates an execution

    Path parameters

    Table 143. General request informationTable 146. General request information
    - +@@ -24473,7 +24716,7 @@

    12.1.54. Admin creates an execution
    -

    12.1.55. Admin deletes execution profile

    +

    12.1.56. Admin deletes execution profile

    @@ -24481,7 +24724,7 @@

    12.1.55. Admin deletes execution profil

    Definition

    Table 144. https://localhost:8081/api/admin/config/execution/profile/{profileId}Table 147. https://localhost:8081/api/admin/config/execution/profile/{profileId}
    - +@@ -24511,7 +24754,7 @@

    12.1.55. Admin deletes execution profil

    Path parameters

    Table 145. General request informationTable 148. General request information
    - +@@ -24562,7 +24805,7 @@

    12.1.55. Admin deletes execution profil
    -

    12.1.56. Admin updates execution profile

    +

    12.1.57. Admin updates execution profile

    @@ -24570,7 +24813,7 @@

    12.1.56. Admin updates execution profil

    Definition

    Table 146. https://localhost:8081/api/admin/config/execution/profile/{profileId}Table 149. https://localhost:8081/api/admin/config/execution/profile/{profileId}
    - +@@ -24600,7 +24843,7 @@

    12.1.56. Admin updates execution profil

    Path parameters

    Table 147. General request informationTable 150. General request information
    - +@@ -24677,7 +24920,7 @@

    12.1.56. Admin updates execution profil 
    $ 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}'
    + -d '{"description":"changed description","configurations":[{"uuid":"5a8e548a-169d-4642-8d2d-00bed1357847","executorVersion":0,"enabled":false,"setup":{"credentials":{},"jobParameters":[]}}],"enabled":true}'
    @@ -24686,7 +24929,7 @@

    12.1.56. Admin updates execution profil

    -

    12.1.57. Admin fetches execution profile

    +

    12.1.58. Admin fetches execution profile

    @@ -24694,7 +24937,7 @@

    12.1.57. Admin fetches execution profil

    Definition

    Table 148. https://localhost:8081/api/admin/config/execution/profile/{profileId}Table 151. https://localhost:8081/api/admin/config/execution/profile/{profileId}
    - +@@ -24724,7 +24967,7 @@

    12.1.57. Admin fetches execution profil

    Path parameters

    Table 149. General request informationTable 152. General request information
    - +@@ -24833,12 +25076,12 @@

    12.1.57. Admin fetches execution profil
    -
    {"description":"a description","enabled":true,"configurations":[{"uuid":"f8dd3854-ae30-450a-828a-1b715bcd57d3","name":"New name","productIdentifier":"PDS_CODESCAN","setup":{"baseURL":"https://product.example.com","credentials":{"user":"env:EXAMPLE_USENAME","password":"env:EXAMPLE_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value but changed. Remark: the other parameter (example.key2) has been removed by this call"}]},"executorVersion":1,"enabled":false}],"projectIds":["project-1","project-2"]}
    +
    {"description":"a description","enabled":true,"configurations":[{"uuid":"006a3f33-85f6-4586-a509-5ef17c40004b","name":"New name","productIdentifier":"PDS_CODESCAN","setup":{"baseURL":"https://product.example.com","credentials":{"user":"env:EXAMPLE_USENAME","password":"env:EXAMPLE_PASSWORD"},"jobParameters":[{"key":"example.key1","value":"A value but changed. Remark: the other parameter (example.key2) has been removed by this call"}]},"executorVersion":1,"enabled":false}],"projectIds":["project-1","project-2"]}
    -

    12.1.58. Admin fetches execution profile list

    +

    12.1.59. Admin fetches execution profile list

    @@ -24846,7 +25089,7 @@

    12.1.58. Admin fetches execution p

    Definition

    Table 150. https://localhost:8081/api/admin/config/execution/profile/{profileId}Table 153. https://localhost:8081/api/admin/config/execution/profile/{profileId}
    - +@@ -24948,7 +25191,7 @@

    12.1.58. Admin fetches execution p
    -

    12.1.59. Admin assigns execution profile to project

    +

    12.1.60. Admin assigns execution profile to project

    @@ -24956,7 +25199,7 @@

    12.1.59. Admin assigns execu

    Definition

    Table 151. General request informationTable 154. General request information
    - +@@ -24986,7 +25229,7 @@

    12.1.59. Admin assigns execu

    Path parameters

    Table 152. General request informationTable 155. General request information
    - +@@ -25041,7 +25284,7 @@

    12.1.59. Admin assigns execu
    -

    12.1.60. Admin unassigns execution profile from project

    +

    12.1.61. Admin unassigns execution profile from project

    @@ -25049,7 +25292,7 @@

    12.1.60. Admin unassigns

    Definition

    Table 153. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}Table 156. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}
    - +@@ -25079,7 +25322,7 @@

    12.1.60. Admin unassigns

    Path parameters

    Table 154. General request informationTable 157. General request information
    - +@@ -25134,7 +25377,7 @@

    12.1.60. Admin unassigns
    -

    12.1.61. Admin fetches auto cleanup configuration

    +

    12.1.62. Admin fetches auto cleanup configuration

    @@ -25142,7 +25385,7 @@

    12.1.61. Admin fetches auto cl

    Definition

    Table 155. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}Table 158. https://localhost:8081/api/admin/config/execution/profile/{profileId}/project/{projectId}
    - +@@ -25205,7 +25448,7 @@

    12.1.61. Admin fetches auto cl
    -

    12.1.62. Admin updates auto cleanup configuration

    +

    12.1.63. Admin updates auto cleanup configuration

    @@ -25213,7 +25456,7 @@

    12.1.62. Admin updates auto cl

    Definition

    Table 156. General request informationTable 159. General request information
    - +@@ -25273,7 +25516,7 @@

    12.1.62. Admin updates auto cl
    -

    12.1.63. Admin starts encryption rotation

    +

    12.1.64. Admin starts encryption rotation

    @@ -25281,7 +25524,7 @@

    12.1.63. Admin starts encryption rotat

    Definition

    Table 157. General request informationTable 160. General request information
    - +@@ -25345,7 +25588,7 @@

    12.1.63. Admin starts encryption rotat
    -

    12.1.64. Admin fetches encryption status

    +

    12.1.65. Admin fetches encryption status

    @@ -25353,7 +25596,7 @@

    12.1.64. Admin fetches encryption statu

    Definition

    Table 158. General request informationTable 161. General request information
    - +@@ -25485,7 +25728,7 @@

    12.1.64. Admin fetches encryption statu
    -

    12.1.65. Admin disables job processing in scheduler

    +

    12.1.66. Admin disables job processing in scheduler

    @@ -25493,7 +25736,7 @@

    12.1.65. Admin disables job

    Definition

    Table 159. General request informationTable 162. General request information
    - +@@ -25552,7 +25795,7 @@

    12.1.65. Admin disables job
    -

    12.1.66. Admin enables scheduler job processing

    +

    12.1.67. Admin enables scheduler job processing

    @@ -25560,7 +25803,7 @@

    12.1.66. Admin enables scheduler

    Definition

    Table 160. General request informationTable 163. General request information
    - +@@ -25619,7 +25862,7 @@

    12.1.66. Admin enables scheduler
    -

    12.1.67. Admin get scheduler status

    +

    12.1.68. Admin get scheduler status

    @@ -25627,7 +25870,7 @@

    12.1.67. Admin get scheduler status

    Definition

    Table 161. General request informationTable 164. General request information
    - +@@ -25686,7 +25929,7 @@

    12.1.67. Admin get scheduler status

    -

    12.1.68. Admin lists status information

    +

    12.1.69. Admin lists status information

    @@ -25694,7 +25937,7 @@

    12.1.68. Admin lists status information<

    Definition

    Table 162. General request informationTable 165. General request information
    - +@@ -25786,7 +26029,7 @@

    12.1.68. Admin lists status information<
    -

    12.1.69. Admin fetches server runtime data

    +

    12.1.70. Admin fetches server runtime data

    @@ -25794,7 +26037,7 @@

    12.1.69. Admin fetches server runtime

    Definition

    Table 163. General request informationTable 166. General request information
    - +@@ -25866,7 +26109,7 @@

    12.1.69. Admin fetches server runtime
    -

    12.1.70. User lists jobs for project

    +

    12.1.71. User lists jobs for project

    @@ -25874,7 +26117,7 @@

    12.1.70. User lists jobs for project

    Definition

    Table 164. General request informationTable 167. General request information
    - +@@ -25904,7 +26147,7 @@

    12.1.70. User lists jobs for project

    Path parameters

    Table 165. General request informationTable 168. General request information
    - +@@ -25923,6 +26166,41 @@

    12.1.70. User lists jobs for project

    Table 166. https://localhost:8081/api/project/{projectId}/jobsTable 169. https://localhost:8081/api/project/{projectId}/jobs
    +

    Query parameters

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterDescription

    size

    The wanted (maximum) size for the result set. When not defined, the default will be 1.

    page

    The wanted page number. When not defined, the default will be 0.

    metadata.labels.*

    An optional dynamic query parameter to filter jobs by labels. The syntax is 'metadata.labels.${labelKey}=${labelValue}'.

    +

    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.

    withMetaData

    An optional parameter to define if meta data shall be fetched as well. When not defined, the default will be false.

    +

    Request headers

    @@ -26028,7 +26306,7 @@

    12.1.70. User lists jobs for project

    -
    {"page":0,"totalPages":1,"content":[{"jobUUID":"4fc54538-9eab-4eb5-9da4-9d1cc0897760","executedBy":"User1","created":"2024-10-21T16:42:22.956477277","started":"2024-10-21T16:44:22.956508736","ended":"2024-10-21T16:59:22.956525658","executionState":"ENDED","trafficLight":"GREEN","executionResult":"OK","metaData":{"labels":{"stage":"test"}}}]}
    +
    {"page":0,"totalPages":1,"content":[{"jobUUID":"8d080df1-24cd-470f-b8bd-845baf4b7d60","executedBy":"User1","created":"2024-11-27T09:31:45.196835109","started":"2024-11-27T09:33:45.196866799","ended":"2024-11-27T09:48:45.19687809","executionState":"ENDED","trafficLight":"GREEN","executionResult":"OK","metaData":{"labels":{"stage":"test"}}}]}
    @@ -27873,7 +28151,7 @@
    16.5.2.2.3. Profiles
    diff --git a/docs/latest/sechub-tutorials.html b/docs/latest/sechub-tutorials.html index c25081319..99615c0d2 100644 --- a/docs/latest/sechub-tutorials.html +++ b/docs/latest/sechub-tutorials.html @@ -531,7 +531,7 @@
    -

    Documentation version: Server 2.3.1 - Build date: 20241021165905

    +

    Documentation version: Server 2.3.1 modified (commit 7de5e5c) - Build date: 2024-11-27 09:48 (UTCZ)

    @@ -1030,7 +1030,7 @@

    2.2.2. Test PDS solutio