DESCRIBEROOTFOLDERS()`¶

About DescribeRootFolders¶

Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

Method Signature¶

METHODS /AWS1/IF_WDX~DESCRIBEROOTFOLDERS
  IMPORTING
    !IV_AUTHENTICATIONTOKEN TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE OPTIONAL
    !IV_LIMIT TYPE /AWS1/WDXLIMITTYPE OPTIONAL
    !IV_MARKER TYPE /AWS1/WDXPAGEMARKERTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wdxdscrootfoldersrsp
  RAISING
    /AWS1/CX_WDXFAILEDDEPENDENCYEX
    /AWS1/CX_WDXINVALIDARGUMENTEX
    /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_authenticationtoken` `TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE` `/AWS1/WDXAUTHNTCTNHEADERTYPE`¶

Amazon WorkDocs authentication token.

Optional arguments:¶

`iv_limit` `TYPE /AWS1/WDXLIMITTYPE` `/AWS1/WDXLIMITTYPE`¶

The maximum number of items to return.

`iv_marker` `TYPE /AWS1/WDXPAGEMARKERTYPE` `/AWS1/WDXPAGEMARKERTYPE`¶

The marker for the next set of results. (You received this marker from a previous call.)

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wdxdscrootfoldersrsp` `/AWS1/CL_WDXDSCROOTFOLDERSRSP`¶

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->describerootfolders(
  iv_authenticationtoken = |string|
  iv_limit = 123
  iv_marker = |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.
  lv_pagemarkertype = lo_result->get_marker( ).
ENDIF.

/AWS1/IF_WDX=>DESCRIBEROOTFOLDERS()¶