DESCRIBESETTINGS()`¶

About DescribeSettings¶

Retrieves information about the configurable settings for the specified directory.

Method Signature¶

METHODS /AWS1/IF_DSR~DESCRIBESETTINGS
  IMPORTING
    !IV_DIRECTORYID TYPE /AWS1/DSRDIRECTORYID OPTIONAL
    !IV_STATUS TYPE /AWS1/DSRDIRECTORYCONFSTATUS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DSRNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dsrdescrstgsresult
  RAISING
    /AWS1/CX_DSRCLIENTEXCEPTION
    /AWS1/CX_DSRDIRECTORYDOESNOT00
    /AWS1/CX_DSRINVALIDNEXTTOKENEX
    /AWS1/CX_DSRINVALIDPARAMETEREX
    /AWS1/CX_DSRSERVICEEXCEPTION
    /AWS1/CX_DSRUNSUPPORTEDOPEX
    /AWS1/CX_DSRCLIENTEXC
    /AWS1/CX_DSRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_directoryid` `TYPE /AWS1/DSRDIRECTORYID` `/AWS1/DSRDIRECTORYID`¶

The identifier of the directory for which to retrieve information.

Optional arguments:¶

`iv_status` `TYPE /AWS1/DSRDIRECTORYCONFSTATUS` `/AWS1/DSRDIRECTORYCONFSTATUS`¶

The status of the directory settings for which to retrieve information.

`iv_nexttoken` `TYPE /AWS1/DSRNEXTTOKEN` `/AWS1/DSRNEXTTOKEN`¶

The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dsrdescrstgsresult` `/AWS1/CL_DSRDESCRSTGSRESULT`¶

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->describesettings(
  iv_directoryid = |string|
  iv_nexttoken = |string|
  iv_status = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_directoryid = lo_result->get_directoryid( ).
  LOOP AT lo_result->get_settingentries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_directoryconfigurations = lo_row_1->get_type( ).
      lv_directoryconfigurations_1 = lo_row_1->get_name( ).
      lv_directoryconfigurations_2 = lo_row_1->get_allowedvalues( ).
      lv_directoryconfigurations_3 = lo_row_1->get_appliedvalue( ).
      lv_directoryconfigurations_3 = lo_row_1->get_requestedvalue( ).
      lv_directoryconfigurations_4 = lo_row_1->get_requeststatus( ).
      LOOP AT lo_row_1->get_requestdetailedstatus( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_directoryconfigurations_4 = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_directoryconfigurations_5 = lo_row_1->get_requeststatusmessage( ).
      lv_directoryconfigurations_6 = lo_row_1->get_lastupdateddatetime( ).
      lv_directoryconfigurations_7 = lo_row_1->get_lastrequesteddatetime( ).
      lv_directoryconfigurations_8 = lo_row_1->get_datatype( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_DSR=>DESCRIBESETTINGS()¶