Skip to content

/AWS1/IF_WDX=>DESCRIBEFOLDERCONTENTS()

About DescribeFolderContents

Describes the contents of the specified folder, including its documents and subfolders.

By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.

Method Signature

METHODS /AWS1/IF_WDX~DESCRIBEFOLDERCONTENTS
  IMPORTING
    !IV_AUTHENTICATIONTOKEN TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE OPTIONAL
    !IV_FOLDERID TYPE /AWS1/WDXRESOURCEIDTYPE OPTIONAL
    !IV_SORT TYPE /AWS1/WDXRESOURCESORTTYPE OPTIONAL
    !IV_ORDER TYPE /AWS1/WDXORDERTYPE OPTIONAL
    !IV_LIMIT TYPE /AWS1/WDXLIMITTYPE OPTIONAL
    !IV_MARKER TYPE /AWS1/WDXPAGEMARKERTYPE OPTIONAL
    !IV_TYPE TYPE /AWS1/WDXFOLDERCONTENTTYPE OPTIONAL
    !IV_INCLUDE TYPE /AWS1/WDXFIELDNAMESTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wdxdscfoldercontsrsp
  RAISING
    /AWS1/CX_WDXENTITYNOTEXISTSEX
    /AWS1/CX_WDXFAILEDDEPENDENCYEX
    /AWS1/CX_WDXINVALIDARGUMENTEX
    /AWS1/CX_WDXPROHIBITEDSTATEEX
    /AWS1/CX_WDXSERVICEUNAVAILEX
    /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_sort TYPE /AWS1/WDXRESOURCESORTTYPE /AWS1/WDXRESOURCESORTTYPE

The sorting criteria.

iv_order TYPE /AWS1/WDXORDERTYPE /AWS1/WDXORDERTYPE

The order for the contents of the folder.

iv_limit TYPE /AWS1/WDXLIMITTYPE /AWS1/WDXLIMITTYPE

The maximum number of items to return with this call.

iv_marker TYPE /AWS1/WDXPAGEMARKERTYPE /AWS1/WDXPAGEMARKERTYPE

The marker for the next set of results. This marker was received from a previous call.

iv_type TYPE /AWS1/WDXFOLDERCONTENTTYPE /AWS1/WDXFOLDERCONTENTTYPE

The type of items.

iv_include TYPE /AWS1/WDXFIELDNAMESTYPE /AWS1/WDXFIELDNAMESTYPE

The contents to include. Specify "INITIALIZED" to include initialized documents.

RETURNING

oo_output TYPE REF TO /aws1/cl_wdxdscfoldercontsrsp /AWS1/CL_WDXDSCFOLDERCONTSRSP

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->describefoldercontents(
  iv_authenticationtoken = |string|
  iv_folderid = |string|
  iv_include = |string|
  iv_limit = 123
  iv_marker = |string|
  iv_order = |string|
  iv_sort = |string|
  iv_type = |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_folders( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_resourceidtype = lo_row_1->get_id( ).
      lv_resourcenametype = lo_row_1->get_name( ).
      lv_idtype = lo_row_1->get_creatorid( ).
      lv_resourceidtype = lo_row_1->get_parentfolderid( ).
      lv_timestamptype = lo_row_1->get_createdtimestamp( ).
      lv_timestamptype = lo_row_1->get_modifiedtimestamp( ).
      lv_resourcestatetype = lo_row_1->get_resourcestate( ).
      lv_hashtype = lo_row_1->get_signature( ).
      LOOP AT lo_row_1->get_labels( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_sharedlabel = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_sizetype = lo_row_1->get_size( ).
      lv_sizetype = lo_row_1->get_latestversionsize( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_documents( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lv_resourceidtype = lo_row_5->get_id( ).
      lv_idtype = lo_row_5->get_creatorid( ).
      lv_resourceidtype = lo_row_5->get_parentfolderid( ).
      lv_timestamptype = lo_row_5->get_createdtimestamp( ).
      lv_timestamptype = lo_row_5->get_modifiedtimestamp( ).
      lo_documentversionmetadata = lo_row_5->get_latestversionmetadata( ).
      IF lo_documentversionmetadata IS NOT INITIAL.
        lv_documentversionidtype = lo_documentversionmetadata->get_id( ).
        lv_resourcenametype = lo_documentversionmetadata->get_name( ).
        lv_documentcontenttype = lo_documentversionmetadata->get_contenttype( ).
        lv_sizetype = lo_documentversionmetadata->get_size( ).
        lv_hashtype = lo_documentversionmetadata->get_signature( ).
        lv_documentstatustype = lo_documentversionmetadata->get_status( ).
        lv_timestamptype = lo_documentversionmetadata->get_createdtimestamp( ).
        lv_timestamptype = lo_documentversionmetadata->get_modifiedtimestamp( ).
        lv_timestamptype = lo_documentversionmetadata->get_contentcreatedtimestamp( ).
        lv_timestamptype = lo_documentversionmetadata->get_contentmodifiedtimestamp( ).
        lv_idtype = lo_documentversionmetadata->get_creatorid( ).
        LOOP AT lo_documentversionmetadata->get_thumbnail( ) into ls_row_6.
          lv_key = ls_row_6-key.
          lo_value = ls_row_6-value.
          IF lo_value IS NOT INITIAL.
            lv_urltype = lo_value->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_documentversionmetadata->get_source( ) into ls_row_7.
          lv_key_1 = ls_row_7-key.
          lo_value_1 = ls_row_7-value.
          IF lo_value_1 IS NOT INITIAL.
            lv_urltype = lo_value_1->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lv_resourcestatetype = lo_row_5->get_resourcestate( ).
      LOOP AT lo_row_5->get_labels( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_sharedlabel = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_pagemarkertype = lo_result->get_marker( ).
ENDIF.