Skip to content

/AWS1/IF_AGW=>GETDOCUMENTATIONPARTS()

About GetDocumentationParts

Gets documentation parts.

Method Signature

METHODS /AWS1/IF_AGW~GETDOCUMENTATIONPARTS
  IMPORTING
    !IV_RESTAPIID TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_TYPE TYPE /AWS1/AGWDOCUMENTATIONPARTTYPE OPTIONAL
    !IV_NAMEQUERY TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_PATH TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_POSITION TYPE /AWS1/AGWSTRING OPTIONAL
    !IV_LIMIT TYPE /AWS1/AGWNULLABLEINTEGER OPTIONAL
    !IV_LOCATIONSTATUS TYPE /AWS1/AGWLOCATIONSTATUSTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_agwdocumentationparts
  RAISING
    /AWS1/CX_AGWBADREQUESTEX
    /AWS1/CX_AGWNOTFOUNDEXCEPTION
    /AWS1/CX_AGWTOOMANYREQUESTSEX
    /AWS1/CX_AGWUNAUTHORIZEDEX
    /AWS1/CX_AGWCLIENTEXC
    /AWS1/CX_AGWSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_restapiid TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The string identifier of the associated RestApi.

Optional arguments:

iv_type TYPE /AWS1/AGWDOCUMENTATIONPARTTYPE /AWS1/AGWDOCUMENTATIONPARTTYPE

The type of API entities of the to-be-retrieved documentation parts.

iv_namequery TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The name of API entities of the to-be-retrieved documentation parts.

iv_path TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The path of API entities of the to-be-retrieved documentation parts.

iv_position TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The current pagination position in the paged result set.

iv_limit TYPE /AWS1/AGWNULLABLEINTEGER /AWS1/AGWNULLABLEINTEGER

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

iv_locationstatus TYPE /AWS1/AGWLOCATIONSTATUSTYPE /AWS1/AGWLOCATIONSTATUSTYPE

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

RETURNING

oo_output TYPE REF TO /aws1/cl_agwdocumentationparts /AWS1/CL_AGWDOCUMENTATIONPARTS

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->getdocumentationparts(
  iv_limit = 123
  iv_locationstatus = |string|
  iv_namequery = |string|
  iv_path = |string|
  iv_position = |string|
  iv_restapiid = |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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_id( ).
      lo_documentationpartlocati = lo_row_1->get_location( ).
      IF lo_documentationpartlocati IS NOT INITIAL.
        lv_documentationparttype = lo_documentationpartlocati->get_type( ).
        lv_string = lo_documentationpartlocati->get_path( ).
        lv_string = lo_documentationpartlocati->get_method( ).
        lv_documentationpartlocati_1 = lo_documentationpartlocati->get_statuscode( ).
        lv_string = lo_documentationpartlocati->get_name( ).
      ENDIF.
      lv_string = lo_row_1->get_properties( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_position( ).
ENDIF.