Skip to content

/AWS1/IF_DOA=>LISTRECOMMENDATIONS()

About ListRecommendations

Lists recommendations for the specified agent space

Method Signature

METHODS /AWS1/IF_DOA~LISTRECOMMENDATIONS
  IMPORTING
    !IV_AGENTSPACEID TYPE /AWS1/DOAAGENTSPACEID OPTIONAL
    !IV_TASKID TYPE /AWS1/DOARESOURCEID OPTIONAL
    !IV_GOALID TYPE /AWS1/DOARESOURCEID OPTIONAL
    !IV_STATUS TYPE /AWS1/DOARECOMMENDATIONSTATUS OPTIONAL
    !IV_PRIORITY TYPE /AWS1/DOARECPRIORITY OPTIONAL
    !IV_LIMIT TYPE /AWS1/DOAINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DOANEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_doalistrecsresponse
  RAISING
    /AWS1/CX_DOAACCESSDENIEDEX
    /AWS1/CX_DOACONFLICTEXCEPTION
    /AWS1/CX_DOACONTENTSIZEEXCDEX
    /AWS1/CX_DOAINTERNALSERVEREX
    /AWS1/CX_DOAINVALIDPARAMETEREX
    /AWS1/CX_DOARESOURCENOTFOUNDEX
    /AWS1/CX_DOASERVICEQUOTAEXCDEX
    /AWS1/CX_DOATHROTTLINGEX
    /AWS1/CX_DOAVLDTNEXCEPTION
    /AWS1/CX_DOACLIENTEXC
    /AWS1/CX_DOASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_agentspaceid TYPE /AWS1/DOAAGENTSPACEID /AWS1/DOAAGENTSPACEID

The unique identifier for the agent space containing the recommendations

Optional arguments:

iv_taskid TYPE /AWS1/DOARESOURCEID /AWS1/DOARESOURCEID

Optional task ID to filter recommendations by specific task

iv_goalid TYPE /AWS1/DOARESOURCEID /AWS1/DOARESOURCEID

Optional goal ID to filter recommendations by specific goal

iv_status TYPE /AWS1/DOARECOMMENDATIONSTATUS /AWS1/DOARECOMMENDATIONSTATUS

Optional status to filter recommendations by their current status

iv_priority TYPE /AWS1/DOARECPRIORITY /AWS1/DOARECPRIORITY

Optional priority to filter recommendations by priority level

iv_limit TYPE /AWS1/DOAINTEGER /AWS1/DOAINTEGER

Maximum number of recommendations to return in a single response

iv_nexttoken TYPE /AWS1/DOANEXTTOKEN /AWS1/DOANEXTTOKEN

Token for retrieving the next page of results

RETURNING

oo_output TYPE REF TO /aws1/cl_doalistrecsresponse /AWS1/CL_DOALISTRECSRESPONSE

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->listrecommendations(
  iv_agentspaceid = |string|
  iv_goalid = |string|
  iv_limit = 123
  iv_nexttoken = |string|
  iv_priority = |string|
  iv_status = |string|
  iv_taskid = |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_recommendations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_agentspacearn( ).
      lv_string = lo_row_1->get_recommendationid( ).
      lv_string = lo_row_1->get_taskid( ).
      lv_string = lo_row_1->get_goalid( ).
      lv_string = lo_row_1->get_title( ).
      lo_recommendationcontent = lo_row_1->get_content( ).
      IF lo_recommendationcontent IS NOT INITIAL.
        lv_string = lo_recommendationcontent->get_summary( ).
        lv_string = lo_recommendationcontent->get_spec( ).
      ENDIF.
      lv_recommendationstatus = lo_row_1->get_status( ).
      lv_recommendationpriority = lo_row_1->get_priority( ).
      lv_long = lo_row_1->get_goalversion( ).
      lv_string = lo_row_1->get_additionalcontext( ).
      lv_backlogtimestamp = lo_row_1->get_createdat( ).
      lv_backlogtimestamp = lo_row_1->get_updatedat( ).
      lv_long = lo_row_1->get_version( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.