Skip to content

/AWS1/IF_SAG=>STARTPENTESTJOB()

About StartPentestJob

Starts a new pentest job for a pentest configuration. The job executes the security tests defined in the pentest.

Method Signature

METHODS /AWS1/IF_SAG~STARTPENTESTJOB
  IMPORTING
    !IV_AGENTSPACEID TYPE /AWS1/SAGSTRING OPTIONAL
    !IV_PENTESTID TYPE /AWS1/SAGSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sagstartpntstjobout
  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.

iv_pentestid TYPE /AWS1/SAGSTRING /AWS1/SAGSTRING

The unique identifier of the pentest to start a job for.

RETURNING

oo_output TYPE REF TO /aws1/cl_sagstartpntstjobout /AWS1/CL_SAGSTARTPNTSTJOBOUT

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->startpentestjob(
  iv_agentspaceid = |string|
  iv_pentestid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_title( ).
  lv_jobstatus = lo_result->get_status( ).
  lv_timestamp = lo_result->get_createdat( ).
  lv_timestamp = lo_result->get_updatedat( ).
  lv_string = lo_result->get_pentestid( ).
  lv_string = lo_result->get_pentestjobid( ).
  lv_string = lo_result->get_agentspaceid( ).
ENDIF.