Skip to content

/AWS1/IF_SAG=>LISTPENTESTJOBTASKS()

About ListPentestJobTasks

Returns a paginated list of task summaries for the specified pentest job, optionally filtered by step name or category.

Method Signature

METHODS /AWS1/IF_SAG~LISTPENTESTJOBTASKS
  IMPORTING
    !IV_AGENTSPACEID TYPE /AWS1/SAGSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SAGMAXRESULTS OPTIONAL
    !IV_PENTESTJOBID TYPE /AWS1/SAGSTRING OPTIONAL
    !IV_STEPNAME TYPE /AWS1/SAGSTEPNAME OPTIONAL
    !IV_CATEGORYNAME TYPE /AWS1/SAGSTRING OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SAGNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_saglstpntstjobtsksout
  RAISING
    /AWS1/CX_SAGCLIENTEXC
    /AWS1/CX_SAGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_agentspaceid TYPE /AWS1/SAGSTRING /AWS1/SAGSTRING

The unique identifier of the agent space.

Optional arguments:

iv_maxresults TYPE /AWS1/SAGMAXRESULTS /AWS1/SAGMAXRESULTS

The maximum number of results to return in a single call.

iv_pentestjobid TYPE /AWS1/SAGSTRING /AWS1/SAGSTRING

The unique identifier of the pentest job to list tasks for.

iv_stepname TYPE /AWS1/SAGSTEPNAME /AWS1/SAGSTEPNAME

Filter tasks by step name. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, and FINALIZING.

iv_categoryname TYPE /AWS1/SAGSTRING /AWS1/SAGSTRING

Filter tasks by category name.

iv_nexttoken TYPE /AWS1/SAGNEXTTOKEN /AWS1/SAGNEXTTOKEN

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

RETURNING

oo_output TYPE REF TO /aws1/cl_saglstpntstjobtsksout /AWS1/CL_SAGLSTPNTSTJOBTSKSOUT

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listpentestjobtasks(
  iv_agentspaceid = |string|
  iv_categoryname = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_pentestjobid = |string|
  iv_stepname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_tasksummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_taskid( ).
      lv_string = lo_row_1->get_pentestid( ).
      lv_string = lo_row_1->get_pentestjobid( ).
      lv_string = lo_row_1->get_agentspaceid( ).
      lv_string = lo_row_1->get_title( ).
      lv_risktype = lo_row_1->get_risktype( ).
      lv_taskexecutionstatus = lo_row_1->get_executionstatus( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_updatedat( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.