Skip to content

/AWS1/IF_CRM=>LISTPRIVACYBUDGETS()

About ListPrivacyBudgets

Returns detailed information about the privacy budgets in a specified membership.

Method Signature

METHODS /AWS1/IF_CRM~LISTPRIVACYBUDGETS
  IMPORTING
    !IV_MEMBERSHIPIDENTIFIER TYPE /AWS1/CRMMEMBERSHIPIDENTIFIER OPTIONAL
    !IV_PRIVACYBUDGETTYPE TYPE /AWS1/CRMPRIVACYBUDGETTYPE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CRMPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CRMMAXRESULTS OPTIONAL
    !IV_ACCESSBUDGETRESOURCEARN TYPE /AWS1/CRMBUDGETEDRESOURCEARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_crmlstprivacybudget01
  RAISING
    /AWS1/CX_CRMACCESSDENIEDEX
    /AWS1/CX_CRMINTERNALSERVEREX
    /AWS1/CX_CRMRESOURCENOTFOUNDEX
    /AWS1/CX_CRMTHROTTLINGEX
    /AWS1/CX_CRMVALIDATIONEX
    /AWS1/CX_CRMCLIENTEXC
    /AWS1/CX_CRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_membershipidentifier TYPE /AWS1/CRMMEMBERSHIPIDENTIFIER /AWS1/CRMMEMBERSHIPIDENTIFIER

A unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.

iv_privacybudgettype TYPE /AWS1/CRMPRIVACYBUDGETTYPE /AWS1/CRMPRIVACYBUDGETTYPE

The privacy budget type.

Optional arguments:

iv_nexttoken TYPE /AWS1/CRMPAGINATIONTOKEN /AWS1/CRMPAGINATIONTOKEN

The pagination token that's used to fetch the next set of results.

iv_maxresults TYPE /AWS1/CRMMAXRESULTS /AWS1/CRMMAXRESULTS

The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

iv_accessbudgetresourcearn TYPE /AWS1/CRMBUDGETEDRESOURCEARN /AWS1/CRMBUDGETEDRESOURCEARN

The Amazon Resource Name (ARN) of the access budget resource to filter privacy budgets by.

RETURNING

oo_output TYPE REF TO /aws1/cl_crmlstprivacybudget01 /AWS1/CL_CRMLSTPRIVACYBUDGET01

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->listprivacybudgets(
  iv_accessbudgetresourcearn = |string|
  iv_maxresults = 123
  iv_membershipidentifier = |string|
  iv_nexttoken = |string|
  iv_privacybudgettype = |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_privacybudgetsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_uuid = lo_row_1->get_id( ).
      lv_privacybudgettemplateid = lo_row_1->get_privacybudgettmplid00( ).
      lv_privacybudgettemplatear = lo_row_1->get_privacybudgettemplatearn( ).
      lv_membershipidentifier = lo_row_1->get_membershipid( ).
      lv_membershiparn = lo_row_1->get_membershiparn( ).
      lv_uuid = lo_row_1->get_collaborationid( ).
      lv_collaborationarn = lo_row_1->get_collaborationarn( ).
      lv_privacybudgettype = lo_row_1->get_type( ).
      lv_timestamp = lo_row_1->get_createtime( ).
      lv_timestamp = lo_row_1->get_updatetime( ).
      lo_privacybudget = lo_row_1->get_budget( ).
      IF lo_privacybudget IS NOT INITIAL.
        lo_differentialprivacypriv = lo_privacybudget->get_differentialprivacy( ).
        IF lo_differentialprivacypriv IS NOT INITIAL.
          LOOP AT lo_differentialprivacypriv->get_aggregations( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_differentialprivacyaggr = lo_row_3->get_type( ).
              lv_integer = lo_row_3->get_maxcount( ).
              lv_integer = lo_row_3->get_remainingcount( ).
            ENDIF.
          ENDLOOP.
          lv_epsilon = lo_differentialprivacypriv->get_epsilon( ).
        ENDIF.
        lo_accessbudget = lo_privacybudget->get_accessbudget( ).
        IF lo_accessbudget IS NOT INITIAL.
          lv_budgetedresourcearn = lo_accessbudget->get_resourcearn( ).
          LOOP AT lo_accessbudget->get_details( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_timestamp = lo_row_5->get_starttime( ).
              lv_timestamp = lo_row_5->get_endtime( ).
              lv_remainingbudget = lo_row_5->get_remainingbudget( ).
              lv_budget = lo_row_5->get_budget( ).
              lv_accessbudgettype = lo_row_5->get_budgettype( ).
              lv_autorefreshmode = lo_row_5->get_autorefresh( ).
            ENDIF.
          ENDLOOP.
          lv_remainingbudget = lo_accessbudget->get_aggregateremainingbudget( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.