LISTCONSUMABLERESOURCES()`¶

About ListConsumableResources¶

Returns a list of Batch consumable resources.

Method Signature¶

METHODS /AWS1/IF_BTC~LISTCONSUMABLERESOURCES
  IMPORTING
    !IT_FILTERS TYPE /AWS1/CL_BTCKEYVALUESPAIR=>TT_LSTCONSUMABLERESRCSFILTLST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BTCINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BTCSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_btclstconsumableres01
  RAISING
    /AWS1/CX_BTCCLIENTEXCEPTION
    /AWS1/CX_BTCSERVEREXCEPTION
    /AWS1/CX_BTCCLIENTEXC
    /AWS1/CX_BTCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_BTCKEYVALUESPAIR=>TT_LSTCONSUMABLERESRCSFILTLST` `TT_LSTCONSUMABLERESRCSFILTLST`¶

The filters to apply to the consumable resource list query. If used, only those consumable resources that match the filter are listed. Filter names and values can be:

name: CONSUMABLE_RESOURCE_NAME

values: case-insensitive matches for the consumable resource name. If a filter value ends with an asterisk (), it matches any consumable resource name that begins with the string before the ''.

`iv_maxresults` `TYPE /AWS1/BTCINTEGER` `/AWS1/BTCINTEGER`¶

The maximum number of results returned by ListConsumableResources in paginated output. When this parameter is used, ListConsumableResources only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListConsumableResources request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListConsumableResources returns up to 100 results and a nextToken value if applicable.

`iv_nexttoken` `TYPE /AWS1/BTCSTRING` `/AWS1/BTCSTRING`¶

The nextToken value returned from a previous paginated ListConsumableResources request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_btclstconsumableres01` `/AWS1/CL_BTCLSTCONSUMABLERES01`¶

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->listconsumableresources(
  it_filters = VALUE /aws1/cl_btckeyvaluespair=>tt_lstconsumableresrcsfiltlst(
    (
      new /aws1/cl_btckeyvaluespair(
        it_values = VALUE /aws1/cl_btcstringlist_w=>tt_stringlist(
          ( new /aws1/cl_btcstringlist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_maxresults = 123
  iv_nexttoken = |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_consumableresources( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_consumableresourcearn( ).
      lv_string = lo_row_1->get_consumableresourcename( ).
      lv_long = lo_row_1->get_totalquantity( ).
      lv_long = lo_row_1->get_inusequantity( ).
      lv_string = lo_row_1->get_resourcetype( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

To get a list of a consumable resources¶

Returns a list of the consumable resources for your account.

DATA(lo_result) = lo_client->listconsumableresources(
  it_filters = VALUE /aws1/cl_btckeyvaluespair=>tt_lstconsumableresrcsfiltlst(
    (
      new /aws1/cl_btckeyvaluespair(
        it_values = VALUE /aws1/cl_btcstringlist_w=>tt_stringlist(
          ( new /aws1/cl_btcstringlist_w( |my*| ) )
        )
        iv_name = |CONSUMABLE_RESOURCE_NAME|
      )
    )
  )
  iv_maxresults = 123
).

/AWS1/IF_BTC=>LISTCONSUMABLERESOURCES()¶