/AWS1/IF_BDO=>GETCONSENTPORTAL()

About GetConsentPortal

Retrieves information about a consent portal.

Method Signature

METHODS /AWS1/IF_BDO~GETCONSENTPORTAL
  IMPORTING
    !IV_CONSENTPORTALIDENTIFIER TYPE /AWS1/BDOCONSENTPORTALID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdogetconsentportlrsp
  RAISING
    /AWS1/CX_BDOACCESSDENIEDEX
    /AWS1/CX_BDOINTERNALSERVEREX
    /AWS1/CX_BDORESOURCENOTFOUNDEX
    /AWS1/CX_BDOTHROTTLINGEX
    /AWS1/CX_BDOUNAUTHORIZEDEX
    /AWS1/CX_BDOVALIDATIONEX
    /AWS1/CX_BDOCLIENTEXC
    /AWS1/CX_BDOSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_consentportalidentifier TYPE /AWS1/BDOCONSENTPORTALID /AWS1/BDOCONSENTPORTALID

The identifier of the consent portal. You can specify either the consent portal ID or its Amazon Resource Name (ARN).

RETURNING

oo_output TYPE REF TO /aws1/cl_bdogetconsentportlrsp /AWS1/CL_BDOGETCONSENTPORTLRSP

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->getconsentportal( |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_sources( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_consentportalsourceiden = lo_row_1->get_identifier( ).
      lv_consentportalsourcetype = lo_row_1->get_type( ).
    ENDIF.
  ENDLOOP.
  lv_consentportalarntype = lo_result->get_consentportalarn( ).
  lv_consentportalidtype = lo_result->get_consentportalid( ).
  lv_timestamp = lo_result->get_createdat( ).
  lv_consentportaldescriptio = lo_result->get_description( ).
  lv_executionrolearntype = lo_result->get_executionrolearn( ).
  lo_consentportalidpconfig = lo_result->get_idpconfig( ).
  IF lo_consentportalidpconfig IS NOT INITIAL.
    lv_oauth2credentialprovide = lo_consentportalidpconfig->get_credentialproviderarn( ).
    LOOP AT lo_consentportalidpconfig->get_scopes( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_allowedscopetype = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_allowedaudiencetype = lo_consentportalidpconfig->get_audience( ).
  ENDIF.
  lv_consentportalnametype = lo_result->get_name( ).
  lv_portalurltype = lo_result->get_portalurl( ).
  lv_consentportalstatus = lo_result->get_status( ).
  lv_statusreasontype = lo_result->get_statusreason( ).
  lv_timestamp = lo_result->get_updatedat( ).
ENDIF.