Skip to content

/AWS1/IF_LOE=>LISTLABELS()

About ListLabels

Provides a list of labels.

Method Signature

METHODS /AWS1/IF_LOE~LISTLABELS
  IMPORTING
    !IV_LABELGROUPNAME TYPE /AWS1/LOELABELGROUPNAME OPTIONAL
    !IV_INTERVALSTARTTIME TYPE /AWS1/LOETIMESTAMP OPTIONAL
    !IV_INTERVALENDTIME TYPE /AWS1/LOETIMESTAMP OPTIONAL
    !IV_FAULTCODE TYPE /AWS1/LOEFAULTCODE OPTIONAL
    !IV_EQUIPMENT TYPE /AWS1/LOEEQUIPMENT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LOENEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LOEMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_loelistlabelsresponse
  RAISING
    /AWS1/CX_LOEACCESSDENIEDEX
    /AWS1/CX_LOEINTERNALSERVEREX
    /AWS1/CX_LOETHROTTLINGEX
    /AWS1/CX_LOEVALIDATIONEX
    /AWS1/CX_LOECLIENTEXC
    /AWS1/CX_LOESERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_labelgroupname TYPE /AWS1/LOELABELGROUPNAME /AWS1/LOELABELGROUPNAME

Returns the name of the label group.

Optional arguments:

iv_intervalstarttime TYPE /AWS1/LOETIMESTAMP /AWS1/LOETIMESTAMP

Returns all the labels with a end time equal to or later than the start time given.

iv_intervalendtime TYPE /AWS1/LOETIMESTAMP /AWS1/LOETIMESTAMP

Returns all labels with a start time earlier than the end time given.

iv_faultcode TYPE /AWS1/LOEFAULTCODE /AWS1/LOEFAULTCODE

Returns labels with a particular fault code.

iv_equipment TYPE /AWS1/LOEEQUIPMENT /AWS1/LOEEQUIPMENT

Lists the labels that pertain to a particular piece of equipment.

iv_nexttoken TYPE /AWS1/LOENEXTTOKEN /AWS1/LOENEXTTOKEN

An opaque pagination token indicating where to continue the listing of label groups.

iv_maxresults TYPE /AWS1/LOEMAXRESULTS /AWS1/LOEMAXRESULTS

Specifies the maximum number of labels to list.

RETURNING

oo_output TYPE REF TO /aws1/cl_loelistlabelsresponse /AWS1/CL_LOELISTLABELSRESPONSE

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->listlabels(
  iv_equipment = |string|
  iv_faultcode = |string|
  iv_intervalendtime = '20150101000000.0000000'
  iv_intervalstarttime = '20150101000000.0000000'
  iv_labelgroupname = |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.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_labelsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_labelgroupname = lo_row_1->get_labelgroupname( ).
      lv_labelid = lo_row_1->get_labelid( ).
      lv_labelgrouparn = lo_row_1->get_labelgrouparn( ).
      lv_timestamp = lo_row_1->get_starttime( ).
      lv_timestamp = lo_row_1->get_endtime( ).
      lv_labelrating = lo_row_1->get_rating( ).
      lv_faultcode = lo_row_1->get_faultcode( ).
      lv_equipment = lo_row_1->get_equipment( ).
      lv_timestamp = lo_row_1->get_createdat( ).
    ENDIF.
  ENDLOOP.
ENDIF.