LISTENGAGEMENTS()`¶

About ListEngagements¶

Lists all engagements that have happened in an incident.

Method Signature¶

METHODS /AWS1/IF_SMC~LISTENGAGEMENTS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/SMCPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SMCMAXRESULTS OPTIONAL
    !IV_INCIDENTID TYPE /AWS1/SMCINCIDENTID OPTIONAL
    !IO_TIMERANGEVALUE TYPE REF TO /AWS1/CL_SMCTIMERANGE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_smclstengagementsrslt
  RAISING
    /AWS1/CX_SMCACCESSDENIEDEX
    /AWS1/CX_SMCINTERNALSERVEREX
    /AWS1/CX_SMCTHROTTLINGEX
    /AWS1/CX_SMCVALIDATIONEX
    /AWS1/CX_SMCCLIENTEXC
    /AWS1/CX_SMCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/SMCPAGINATIONTOKEN` `/AWS1/SMCPAGINATIONTOKEN`¶

The pagination token to continue to the next page of results.

`iv_maxresults` `TYPE /AWS1/SMCMAXRESULTS` `/AWS1/SMCMAXRESULTS`¶

The maximum number of engagements per page of results.

`iv_incidentid` `TYPE /AWS1/SMCINCIDENTID` `/AWS1/SMCINCIDENTID`¶

The Amazon Resource Name (ARN) of the incident you're listing engagements for.

`io_timerangevalue` `TYPE REF TO /AWS1/CL_SMCTIMERANGE` `/AWS1/CL_SMCTIMERANGE`¶

The time range to lists engagements for an incident.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_smclstengagementsrslt` `/AWS1/CL_SMCLSTENGAGEMENTSRSLT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

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->listengagements(
  io_timerangevalue = new /aws1/cl_smctimerange(
    iv_endtime = '20150101000000.0000000'
    iv_starttime = '20150101000000.0000000'
  )
  iv_incidentid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_paginationtoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_engagements( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_ssmcontactsarn = lo_row_1->get_engagementarn( ).
      lv_ssmcontactsarn = lo_row_1->get_contactarn( ).
      lv_sender = lo_row_1->get_sender( ).
      lv_incidentid = lo_row_1->get_incidentid( ).
      lv_datetime = lo_row_1->get_starttime( ).
      lv_datetime = lo_row_1->get_stoptime( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_SMC=>LISTENGAGEMENTS()¶