LISTTIMESERIES()`¶

About ListTimeSeries¶

Retrieves a paginated list of time series (data streams).

Method Signature¶

METHODS /AWS1/IF_IOS~LISTTIMESERIES
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/IOSNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOSMAXRESULTS OPTIONAL
    !IV_ASSETID TYPE /AWS1/IOSCUSTOMID OPTIONAL
    !IV_ALIASPREFIX TYPE /AWS1/IOSPROPERTYALIAS OPTIONAL
    !IV_TIMESERIESTYPE TYPE /AWS1/IOSLISTTIMESERIESTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioslisttimeseriesrsp
  RAISING
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/IOSNEXTTOKEN` `/AWS1/IOSNEXTTOKEN`¶

The token to be used for the next set of paginated results.

`iv_maxresults` `TYPE /AWS1/IOSMAXRESULTS` `/AWS1/IOSMAXRESULTS`¶

The maximum number of results to return for each paginated request.

`iv_assetid` `TYPE /AWS1/IOSCUSTOMID` `/AWS1/IOSCUSTOMID`¶

The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

`iv_aliasprefix` `TYPE /AWS1/IOSPROPERTYALIAS` `/AWS1/IOSPROPERTYALIAS`¶

The alias prefix of the time series.

`iv_timeseriestype` `TYPE /AWS1/IOSLISTTIMESERIESTYPE` `/AWS1/IOSLISTTIMESERIESTYPE`¶

The type of the time series. The time series type can be one of the following values:

ASSOCIATED – The time series is associated with an asset property.

DISASSOCIATED – The time series isn't associated with any asset property.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ioslisttimeseriesrsp` `/AWS1/CL_IOSLISTTIMESERIESRSP`¶

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->listtimeseries(
  iv_aliasprefix = |string|
  iv_assetid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_timeseriestype = |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_timeseriessummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_id = lo_row_1->get_assetid( ).
      lv_id = lo_row_1->get_propertyid( ).
      lv_propertyalias = lo_row_1->get_alias( ).
      lv_timeseriesid = lo_row_1->get_timeseriesid( ).
      lv_propertydatatype = lo_row_1->get_datatype( ).
      lv_name = lo_row_1->get_datatypespec( ).
      lv_timestamp = lo_row_1->get_timeseriescreationdate( ).
      lv_timestamp = lo_row_1->get_timeserieslastupdatedate( ).
      lv_arn = lo_row_1->get_timeseriesarn( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_IOS=>LISTTIMESERIES()¶