Skip to content

/AWS1/IF_WDX=>DESCRIBEDOCUMENTVERSIONS()

About DescribeDocumentVersions

Retrieves the document versions for the specified document.

By default, only active versions are returned.

Method Signature

METHODS /AWS1/IF_WDX~DESCRIBEDOCUMENTVERSIONS
  IMPORTING
    !IV_AUTHENTICATIONTOKEN TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE OPTIONAL
    !IV_DOCUMENTID TYPE /AWS1/WDXRESOURCEIDTYPE OPTIONAL
    !IV_MARKER TYPE /AWS1/WDXPAGEMARKERTYPE OPTIONAL
    !IV_LIMIT TYPE /AWS1/WDXLIMITTYPE OPTIONAL
    !IV_INCLUDE TYPE /AWS1/WDXFIELDNAMESTYPE OPTIONAL
    !IV_FIELDS TYPE /AWS1/WDXFIELDNAMESTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wdxdescrdocvrssrsp
  RAISING
    /AWS1/CX_WDXENTITYNOTEXISTSEX
    /AWS1/CX_WDXFAILEDDEPENDENCYEX
    /AWS1/CX_WDXINVALIDARGUMENTEX
    /AWS1/CX_WDXINVALIDPASSWORDEX
    /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_documentid TYPE /AWS1/WDXRESOURCEIDTYPE /AWS1/WDXRESOURCEIDTYPE

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_marker TYPE /AWS1/WDXPAGEMARKERTYPE /AWS1/WDXPAGEMARKERTYPE

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

iv_limit TYPE /AWS1/WDXLIMITTYPE /AWS1/WDXLIMITTYPE

The maximum number of versions to return with this call.

iv_include TYPE /AWS1/WDXFIELDNAMESTYPE /AWS1/WDXFIELDNAMESTYPE

A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.

iv_fields TYPE /AWS1/WDXFIELDNAMESTYPE /AWS1/WDXFIELDNAMESTYPE

Specify "SOURCE" to include initialized versions and a URL for the source document.

RETURNING

oo_output TYPE REF TO /aws1/cl_wdxdescrdocvrssrsp /AWS1/CL_WDXDESCRDOCVRSSRSP

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->describedocumentversions(
  iv_authenticationtoken = |string|
  iv_documentid = |string|
  iv_fields = |string|
  iv_include = |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_documentversions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_documentversionidtype = lo_row_1->get_id( ).
      lv_resourcenametype = lo_row_1->get_name( ).
      lv_documentcontenttype = lo_row_1->get_contenttype( ).
      lv_sizetype = lo_row_1->get_size( ).
      lv_hashtype = lo_row_1->get_signature( ).
      lv_documentstatustype = lo_row_1->get_status( ).
      lv_timestamptype = lo_row_1->get_createdtimestamp( ).
      lv_timestamptype = lo_row_1->get_modifiedtimestamp( ).
      lv_timestamptype = lo_row_1->get_contentcreatedtimestamp( ).
      lv_timestamptype = lo_row_1->get_contentmodifiedtimestamp( ).
      lv_idtype = lo_row_1->get_creatorid( ).
      LOOP AT lo_row_1->get_thumbnail( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_urltype = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_source( ) into ls_row_3.
        lv_key_1 = ls_row_3-key.
        lo_value_1 = ls_row_3-value.
        IF lo_value_1 IS NOT INITIAL.
          lv_urltype = lo_value_1->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_pagemarkertype = lo_result->get_marker( ).
ENDIF.