GETFOLDER()`¶

About GetFolder¶

Retrieves the metadata of the specified folder.

Method Signature¶

METHODS /AWS1/IF_WDX~GETFOLDER
  IMPORTING
    !IV_AUTHENTICATIONTOKEN TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE OPTIONAL
    !IV_FOLDERID TYPE /AWS1/WDXRESOURCEIDTYPE OPTIONAL
    !IV_INCLUDECUSTOMMETADATA TYPE /AWS1/WDXBOOLEANTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wdxgetfolderresponse
  RAISING
    /AWS1/CX_WDXENTITYNOTEXISTSEX
    /AWS1/CX_WDXFAILEDDEPENDENCYEX
    /AWS1/CX_WDXINVALIDARGUMENTEX
    /AWS1/CX_WDXPROHIBITEDSTATEEX
    /AWS1/CX_WDXSERVICEUNAVAILEX
    /AWS1/CX_WDXUNAUTHDOPERATIONEX
    /AWS1/CX_WDXUNAUTHDRESRCACCEX
    /AWS1/CX_WDXCLIENTEXC
    /AWS1/CX_WDXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_folderid` `TYPE /AWS1/WDXRESOURCEIDTYPE` `/AWS1/WDXRESOURCEIDTYPE`¶

The ID of the folder.

Optional arguments:¶

`iv_authenticationtoken` `TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE` `/AWS1/WDXAUTHNTCTNHEADERTYPE`¶

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

`iv_includecustommetadata` `TYPE /AWS1/WDXBOOLEANTYPE` `/AWS1/WDXBOOLEANTYPE`¶

Set to TRUE to include custom metadata in the response.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wdxgetfolderresponse` `/AWS1/CL_WDXGETFOLDERRESPONSE`¶

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->getfolder(
  iv_authenticationtoken = |string|
  iv_folderid = |string|
  iv_includecustommetadata = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_foldermetadata = lo_result->get_metadata( ).
  IF lo_foldermetadata IS NOT INITIAL.
    lv_resourceidtype = lo_foldermetadata->get_id( ).
    lv_resourcenametype = lo_foldermetadata->get_name( ).
    lv_idtype = lo_foldermetadata->get_creatorid( ).
    lv_resourceidtype = lo_foldermetadata->get_parentfolderid( ).
    lv_timestamptype = lo_foldermetadata->get_createdtimestamp( ).
    lv_timestamptype = lo_foldermetadata->get_modifiedtimestamp( ).
    lv_resourcestatetype = lo_foldermetadata->get_resourcestate( ).
    lv_hashtype = lo_foldermetadata->get_signature( ).
    LOOP AT lo_foldermetadata->get_labels( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_sharedlabel = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_sizetype = lo_foldermetadata->get_size( ).
    lv_sizetype = lo_foldermetadata->get_latestversionsize( ).
  ENDIF.
  LOOP AT lo_result->get_custommetadata( ) into ls_row_2.
    lv_key = ls_row_2-key.
    lo_value = ls_row_2-value.
    IF lo_value IS NOT INITIAL.
      lv_custommetadatavaluetype = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_WDX=>GETFOLDER()¶