LISTCOMMENTS()`¶

About ListComments¶

Returns comments for a designated case.

Method Signature¶

METHODS /AWS1/IF_SHI~LISTCOMMENTS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/SHISTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SHIINTEGER OPTIONAL
    !IV_CASEID TYPE /AWS1/SHICASEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_shilistcommentsrsp
  RAISING
    /AWS1/CX_SHIACCESSDENIEDEX
    /AWS1/CX_SHICONFLICTEXCEPTION
    /AWS1/CX_SHIINTERNALSERVEREX
    /AWS1/CX_SHIINVALIDTOKENEX
    /AWS1/CX_SHIRESOURCENOTFOUNDEX
    /AWS1/CX_SHISECINCIDENTRSPNO00
    /AWS1/CX_SHISERVICEQUOTAEXCDEX
    /AWS1/CX_SHITHROTTLINGEX
    /AWS1/CX_SHIVALIDATIONEX
    /AWS1/CX_SHICLIENTEXC
    /AWS1/CX_SHISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_caseid` `TYPE /AWS1/SHICASEID` `/AWS1/SHICASEID`¶

Required element for ListComments to designate the case to query.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/SHISTRING` `/AWS1/SHISTRING`¶

An optional string that, if supplied, must be copied from the output of a previous call to ListComments. When provided in this manner, the API fetches the next page of results.

`iv_maxresults` `TYPE /AWS1/SHIINTEGER` `/AWS1/SHIINTEGER`¶

Optional element for ListComments to limit the number of responses.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_shilistcommentsrsp` `/AWS1/CL_SHILISTCOMMENTSRSP`¶

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->listcomments(
  iv_caseid = |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_string = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_commentid = lo_row_1->get_commentid( ).
      lv_timestamp = lo_row_1->get_createddate( ).
      lv_timestamp = lo_row_1->get_lastupdateddate( ).
      lv_principalid = lo_row_1->get_creator( ).
      lv_principalid = lo_row_1->get_lastupdatedby( ).
      lv_commentbody = lo_row_1->get_body( ).
    ENDIF.
  ENDLOOP.
  lv_integer = lo_result->get_total( ).
ENDIF.

Invoke ListComments¶

Invoke ListComments

DATA(lo_result) = lo_client->listcomments( iv_caseid = |8403556009| ) .

/AWS1/IF_SHI=>LISTCOMMENTS()¶