Skip to content

/AWS1/IF_DOA=>GETRECOMMENDATION()

About GetRecommendation

Retrieves a specific recommendation by its ID

Method Signature

METHODS /AWS1/IF_DOA~GETRECOMMENDATION
  IMPORTING
    !IV_AGENTSPACEID TYPE /AWS1/DOAAGENTSPACEID OPTIONAL
    !IV_RECOMMENDATIONID TYPE /AWS1/DOARESOURCEID OPTIONAL
    !IV_RECOMMENDATIONVERSION TYPE /AWS1/DOALONG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_doagetrecresponse
  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 recommendation

iv_recommendationid TYPE /AWS1/DOARESOURCEID /AWS1/DOARESOURCEID

The unique identifier for the recommendation to retrieve

Optional arguments:

iv_recommendationversion TYPE /AWS1/DOALONG /AWS1/DOALONG

Specific version of the recommendation to retrieve. If not specified, returns the latest version.

RETURNING

oo_output TYPE REF TO /aws1/cl_doagetrecresponse /AWS1/CL_DOAGETRECRESPONSE

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->getrecommendation(
  iv_agentspaceid = |string|
  iv_recommendationid = |string|
  iv_recommendationversion = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_recommendation = lo_result->get_recommendation( ).
  IF lo_recommendation IS NOT INITIAL.
    lv_string = lo_recommendation->get_agentspacearn( ).
    lv_string = lo_recommendation->get_recommendationid( ).
    lv_string = lo_recommendation->get_taskid( ).
    lv_string = lo_recommendation->get_goalid( ).
    lv_string = lo_recommendation->get_title( ).
    lo_recommendationcontent = lo_recommendation->get_content( ).
    IF lo_recommendationcontent IS NOT INITIAL.
      lv_string = lo_recommendationcontent->get_summary( ).
      lv_string = lo_recommendationcontent->get_spec( ).
    ENDIF.
    lv_recommendationstatus = lo_recommendation->get_status( ).
    lv_recommendationpriority = lo_recommendation->get_priority( ).
    lv_long = lo_recommendation->get_goalversion( ).
    lv_string = lo_recommendation->get_additionalcontext( ).
    lv_backlogtimestamp = lo_recommendation->get_createdat( ).
    lv_backlogtimestamp = lo_recommendation->get_updatedat( ).
    lv_long = lo_recommendation->get_version( ).
  ENDIF.
ENDIF.