GETJOURNEYRUNS()`¶

About GetJourneyRuns¶

Provides information about the runs of a journey.

Method Signature¶

METHODS /AWS1/IF_PPT~GETJOURNEYRUNS
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/PPT__STRING OPTIONAL
    !IV_JOURNEYID TYPE /AWS1/PPT__STRING OPTIONAL
    !IV_PAGESIZE TYPE /AWS1/PPT__STRING OPTIONAL
    !IV_TOKEN TYPE /AWS1/PPT__STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pptgetjourneyrunsrsp
  RAISING
    /AWS1/CX_PPTBADREQUESTEX
    /AWS1/CX_PPTFORBIDDENEXCEPTION
    /AWS1/CX_PPTINTERNALSERVERER00
    /AWS1/CX_PPTMETHODNOTALLOWEDEX
    /AWS1/CX_PPTNOTFOUNDEXCEPTION
    /AWS1/CX_PPTPAYLOADTOOLARGEEX
    /AWS1/CX_PPTTOOMANYREQUESTSEX
    /AWS1/CX_PPTCLIENTEXC
    /AWS1/CX_PPTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_applicationid` `TYPE /AWS1/PPTSTRING` `/AWS1/PPTSTRING`¶

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

`iv_journeyid` `TYPE /AWS1/PPTSTRING` `/AWS1/PPTSTRING`¶

The unique identifier for the journey.

Optional arguments:¶

`iv_pagesize` `TYPE /AWS1/PPTSTRING` `/AWS1/PPTSTRING`¶

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

`iv_token` `TYPE /AWS1/PPTSTRING` `/AWS1/PPTSTRING`¶

The NextToken string that specifies which page of results to return in a paginated response.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pptgetjourneyrunsrsp` `/AWS1/CL_PPTGETJOURNEYRUNSRSP`¶

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->getjourneyruns(
  iv_applicationid = |string|
  iv_journeyid = |string|
  iv_pagesize = |string|
  iv_token = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_journeyrunsresponse = lo_result->get_journeyrunsresponse( ).
  IF lo_journeyrunsresponse IS NOT INITIAL.
    LOOP AT lo_journeyrunsresponse->get_item( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv___string = lo_row_1->get_creationtime( ).
        lv___string = lo_row_1->get_lastupdatetime( ).
        lv___string = lo_row_1->get_runid( ).
        lv_journeyrunstatus = lo_row_1->get_status( ).
      ENDIF.
    ENDLOOP.
    lv___string = lo_journeyrunsresponse->get_nexttoken( ).
  ENDIF.
ENDIF.

To get the runs of a journey¶

The following example gets the runs of a journey.

DATA(lo_result) = lo_client->getjourneyruns(
  iv_applicationid = |11111111112222222222333333333344|
  iv_journeyid = |aaaaaaaaaabbbbbbbbbbccccccccccdd|
).

/AWS1/IF_PPT=>GETJOURNEYRUNS()¶