GETDOCUMENTPATH()`¶

About GetDocumentPath¶

Retrieves the path information (the hierarchy from the root folder) for the requested document.

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.

Method Signature¶

METHODS /AWS1/IF_WDX~GETDOCUMENTPATH
  IMPORTING
    !IV_AUTHENTICATIONTOKEN TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE OPTIONAL
    !IV_DOCUMENTID TYPE /AWS1/WDXIDTYPE OPTIONAL
    !IV_LIMIT TYPE /AWS1/WDXLIMITTYPE OPTIONAL
    !IV_FIELDS TYPE /AWS1/WDXFIELDNAMESTYPE OPTIONAL
    !IV_MARKER TYPE /AWS1/WDXPAGEMARKERTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wdxgetdocpathresponse
  RAISING
    /AWS1/CX_WDXENTITYNOTEXISTSEX
    /AWS1/CX_WDXFAILEDDEPENDENCYEX
    /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_documentid` `TYPE /AWS1/WDXIDTYPE` `/AWS1/WDXIDTYPE`¶

The ID of the document.

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_limit` `TYPE /AWS1/WDXLIMITTYPE` `/AWS1/WDXLIMITTYPE`¶

The maximum number of levels in the hierarchy to return.

`iv_fields` `TYPE /AWS1/WDXFIELDNAMESTYPE` `/AWS1/WDXFIELDNAMESTYPE`¶

A comma-separated list of values. Specify NAME to include the names of the parent folders.

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

This value is not supported.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_wdxgetdocpathresponse` `/AWS1/CL_WDXGETDOCPATHRESPONSE`¶

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->getdocumentpath(
  iv_authenticationtoken = |string|
  iv_documentid = |string|
  iv_fields = |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.
  lo_resourcepath = lo_result->get_path( ).
  IF lo_resourcepath IS NOT INITIAL.
    LOOP AT lo_resourcepath->get_components( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_idtype = lo_row_1->get_id( ).
        lv_resourcenametype = lo_row_1->get_name( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

/AWS1/IF_WDX=>GETDOCUMENTPATH()¶