Skip to content

/AWS1/IF_DOA=>LISTJOURNALRECORDS()

About ListJournalRecords

List journal records for a specific execution

Method Signature

METHODS /AWS1/IF_DOA~LISTJOURNALRECORDS
  IMPORTING
    !IV_AGENTSPACEID TYPE /AWS1/DOAAGENTSPACEID OPTIONAL
    !IV_EXECUTIONID TYPE /AWS1/DOARESOURCEID OPTIONAL
    !IV_LIMIT TYPE /AWS1/DOAINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DOANEXTTOKEN OPTIONAL
    !IV_RECORDTYPE TYPE /AWS1/DOASTRING OPTIONAL
    !IV_ORDER TYPE /AWS1/DOAORDERTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_doalistjourrecordsrsp
  RAISING
    /AWS1/CX_DOAACCESSDENIEDEX
    /AWS1/CX_DOACONFLICTEXCEPTION
    /AWS1/CX_DOACONTENTSIZEEXCDEX
    /AWS1/CX_DOAINTERNALSERVEREX
    /AWS1/CX_DOAINVALIDPARAMETEREX
    /AWS1/CX_DOARESOURCENOTFOUNDEX
    /AWS1/CX_DOASERVICEQUOTAEXCDEX
    /AWS1/CX_DOATHROTTLINGEX
    /AWS1/CX_DOAVLDTNEXCEPTION
    /AWS1/CX_DOACLIENTEXC
    /AWS1/CX_DOASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_agentspaceid TYPE /AWS1/DOAAGENTSPACEID /AWS1/DOAAGENTSPACEID

The unique identifier for the agent space containing the execution

iv_executionid TYPE /AWS1/DOARESOURCEID /AWS1/DOARESOURCEID

The unique identifier of the execution whose journal records to retrieve

Optional arguments:

iv_limit TYPE /AWS1/DOAINTEGER /AWS1/DOAINTEGER

Maximum number of records to return in a single response (1-100, default: 100)

iv_nexttoken TYPE /AWS1/DOANEXTTOKEN /AWS1/DOANEXTTOKEN

Token for retrieving the next page of results

iv_recordtype TYPE /AWS1/DOASTRING /AWS1/DOASTRING

Filter records by type (empty string returns all types)

iv_order TYPE /AWS1/DOAORDERTYPE /AWS1/DOAORDERTYPE

Sort order for the records based on timestamp (default: DESC)

RETURNING

oo_output TYPE REF TO /aws1/cl_doalistjourrecordsrsp /AWS1/CL_DOALISTJOURRECORDSRSP

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->listjournalrecords(
  iv_agentspaceid = |string|
  iv_executionid = |string|
  iv_limit = 123
  iv_nexttoken = |string|
  iv_order = |string|
  iv_recordtype = |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_records( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_agentspaceid( ).
      lv_string = lo_row_1->get_executionid( ).
      lv_string = lo_row_1->get_recordid( ).
      lo_value = lo_row_1->get_content( ).
      IF lo_value IS NOT INITIAL.
      ENDIF.
      lv_journaltimestamp = lo_row_1->get_createdat( ).
      lv_string = lo_row_1->get_recordtype( ).
      lo_userreference = lo_row_1->get_userreference( ).
      IF lo_userreference IS NOT INITIAL.
        lv_string = lo_userreference->get_userid( ).
        lv_usertype = lo_userreference->get_usertype( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.