Skip to content

/AWS1/CL_IOA=>BATCHPUTMESSAGE()

About BatchPutMessage

Sends messages to a channel.

Method Signature

IMPORTING

Required arguments:

iv_channelname TYPE /AWS1/IOACHANNELNAME /AWS1/IOACHANNELNAME

The name of the channel where the messages are sent.

it_messages TYPE /AWS1/CL_IOAMESSAGE=>TT_MESSAGES TT_MESSAGES

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to IoT Analytics:

  • Must contain only alphanumeric characters and undescores (). No other special characters are allowed.

  • Must begin with an alphabetic character or single underscore ().

  • Cannot contain hyphens (-).

  • In regular expression terms: "^A-Za-z_$".

  • Cannot be more than 255 characters.

  • Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

RETURNING

oo_output TYPE REF TO /aws1/cl_ioabatchputmessagersp /AWS1/CL_IOABATCHPUTMESSAGERSP

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->/aws1/if_ioa~batchputmessage(
  it_messages = VALUE /aws1/cl_ioamessage=>tt_messages(
    (
      new /aws1/cl_ioamessage(
        iv_messageid = |string|
        iv_payload = '5347567362473873563239796247513D'
      )
    )
  )
  iv_channelname = |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_batchputmsgerrorentries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_messageid = lo_row_1->get_messageid( ).
      lv_errorcode = lo_row_1->get_errorcode( ).
      lv_errormessage = lo_row_1->get_errormessage( ).
    ENDIF.
  ENDLOOP.
ENDIF.