Skip to content

/AWS1/IF_PTC=>LISTCHANNELHANDSHAKES()

About ListChannelHandshakes

Lists channel handshakes based on specified criteria.

Method Signature

METHODS /AWS1/IF_PTC~LISTCHANNELHANDSHAKES
  IMPORTING
    !IV_HANDSHAKETYPE TYPE /AWS1/PTCHANDSHAKETYPE OPTIONAL
    !IV_CATALOG TYPE /AWS1/PTCCATALOG OPTIONAL
    !IV_PARTICIPANTTYPE TYPE /AWS1/PTCPARTICIPANTTYPE OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PTCINTEGER OPTIONAL
    !IT_STATUSES TYPE /AWS1/CL_PTCHANDSHAKESTATLST_W=>TT_HANDSHAKESTATUSLIST OPTIONAL
    !IT_ASSOCIATEDRESOURCEIDS TYPE /AWS1/CL_PTCASSOCDRESIDLIST_W=>TT_ASSOCIATEDRESOURCEIDLIST OPTIONAL
    !IO_HANDSHAKETYPEFILTERS TYPE REF TO /AWS1/CL_PTCLSTCHNLHANDSHAKE01 OPTIONAL
    !IO_HANDSHAKETYPESORT TYPE REF TO /AWS1/CL_PTCLSTCHNLHANDSHAKE02 OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PTCNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptclstchnlhandshake03
  RAISING
    /AWS1/CX_PTCACCESSDENIEDEX
    /AWS1/CX_PTCINTERNALSERVEREX
    /AWS1/CX_PTCRESOURCENOTFOUNDEX
    /AWS1/CX_PTCTHROTTLINGEX
    /AWS1/CX_PTCVLDTNEXCEPTION
    /AWS1/CX_PTCCLIENTEXC
    /AWS1/CX_PTCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_handshaketype TYPE /AWS1/PTCHANDSHAKETYPE /AWS1/PTCHANDSHAKETYPE

Filter results by handshake type.

iv_catalog TYPE /AWS1/PTCCATALOG /AWS1/PTCCATALOG

The catalog identifier to filter handshakes.

iv_participanttype TYPE /AWS1/PTCPARTICIPANTTYPE /AWS1/PTCPARTICIPANTTYPE

Filter by participant type (sender or receiver).

Optional arguments:

iv_maxresults TYPE /AWS1/PTCINTEGER /AWS1/PTCINTEGER

The maximum number of results to return in a single call.

it_statuses TYPE /AWS1/CL_PTCHANDSHAKESTATLST_W=>TT_HANDSHAKESTATUSLIST TT_HANDSHAKESTATUSLIST

Filter results by handshake status.

it_associatedresourceids TYPE /AWS1/CL_PTCASSOCDRESIDLIST_W=>TT_ASSOCIATEDRESOURCEIDLIST TT_ASSOCIATEDRESOURCEIDLIST

Filter by associated resource identifiers.

io_handshaketypefilters TYPE REF TO /AWS1/CL_PTCLSTCHNLHANDSHAKE01 /AWS1/CL_PTCLSTCHNLHANDSHAKE01

Type-specific filters for handshakes.

io_handshaketypesort TYPE REF TO /AWS1/CL_PTCLSTCHNLHANDSHAKE02 /AWS1/CL_PTCLSTCHNLHANDSHAKE02

Type-specific sorting options for handshakes.

iv_nexttoken TYPE /AWS1/PTCNEXTTOKEN /AWS1/PTCNEXTTOKEN

Token for retrieving the next page of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptclstchnlhandshake03 /AWS1/CL_PTCLSTCHNLHANDSHAKE03

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->listchannelhandshakes(
  io_handshaketypefilters = new /aws1/cl_ptclstchnlhandshake01(
    io_programmngmtaccttypefilts = new /aws1/cl_ptcprogrammgtactype00(
      it_programs = VALUE /aws1/cl_ptcprogramlist_w=>tt_programlist(
        ( new /aws1/cl_ptcprogramlist_w( |string| ) )
      )
    )
    io_revokesvcpertypefilters = new /aws1/cl_ptcrvksvcpertypefilts(
      it_serviceperiodtypes = VALUE /aws1/cl_ptcsvcpertypelist_w=>tt_serviceperiodtypelist(
        ( new /aws1/cl_ptcsvcpertypelist_w( |string| ) )
      )
    )
    io_startsvcperiodtypefilters = new /aws1/cl_ptcstrtsvcpertypefi00(
      it_serviceperiodtypes = VALUE /aws1/cl_ptcsvcpertypelist_w=>tt_serviceperiodtypelist(
        ( new /aws1/cl_ptcsvcpertypelist_w( |string| ) )
      )
    )
  )
  io_handshaketypesort = new /aws1/cl_ptclstchnlhandshake02(
    io_programmngmtaccttypesort = new /aws1/cl_ptcprogrammgtactype01(
      iv_sortby = |string|
      iv_sortorder = |string|
    )
    io_revokesvcperiodtypesort = new /aws1/cl_ptcrvkesvcpertypesort(
      iv_sortby = |string|
      iv_sortorder = |string|
    )
    io_startsvcperiodtypesort = new /aws1/cl_ptcstrtsvcpertypesort(
      iv_sortby = |string|
      iv_sortorder = |string|
    )
  )
  it_associatedresourceids = VALUE /aws1/cl_ptcassocdresidlist_w=>tt_associatedresourceidlist(
    ( new /aws1/cl_ptcassocdresidlist_w( |string| ) )
  )
  it_statuses = VALUE /aws1/cl_ptchandshakestatlst_w=>tt_handshakestatuslist(
    ( new /aws1/cl_ptchandshakestatlst_w( |string| ) )
  )
  iv_catalog = |string|
  iv_handshaketype = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_participanttype = |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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_channelhandshakeid = lo_row_1->get_id( ).
      lv_arn = lo_row_1->get_arn( ).
      lv_catalog = lo_row_1->get_catalog( ).
      lv_handshaketype = lo_row_1->get_handshaketype( ).
      lv_accountid = lo_row_1->get_owneraccountid( ).
      lv_accountid = lo_row_1->get_senderaccountid( ).
      lv_partnerprofiledisplayna = lo_row_1->get_senderdisplayname( ).
      lv_accountid = lo_row_1->get_receiveraccountid( ).
      lv_associatedresourceid = lo_row_1->get_associatedresourceid00( ).
      lo_handshakedetail = lo_row_1->get_detail( ).
      IF lo_handshakedetail IS NOT INITIAL.
        lo_startserviceperiodhands = lo_handshakedetail->get_startsvcperhandshakedet( ).
        IF lo_startserviceperiodhands IS NOT INITIAL.
          lv_note = lo_startserviceperiodhands->get_note( ).
          lv_serviceperiodtype = lo_startserviceperiodhands->get_serviceperiodtype( ).
          lv_minimumnoticedays = lo_startserviceperiodhands->get_minimumnoticedays( ).
          lv_datetime = lo_startserviceperiodhands->get_startdate( ).
          lv_datetime = lo_startserviceperiodhands->get_enddate( ).
        ENDIF.
        lo_revokeserviceperiodhand = lo_handshakedetail->get_revokesvcperhandshakedet( ).
        IF lo_revokeserviceperiodhand IS NOT INITIAL.
          lv_note = lo_revokeserviceperiodhand->get_note( ).
          lv_serviceperiodtype = lo_revokeserviceperiodhand->get_serviceperiodtype( ).
          lv_minimumnoticedays = lo_revokeserviceperiodhand->get_minimumnoticedays( ).
          lv_datetime = lo_revokeserviceperiodhand->get_startdate( ).
          lv_datetime = lo_revokeserviceperiodhand->get_enddate( ).
        ENDIF.
        lo_programmanagementaccoun = lo_handshakedetail->get_programmngmtaccthandsh00( ).
        IF lo_programmanagementaccoun IS NOT INITIAL.
          lv_program = lo_programmanagementaccoun->get_program( ).
        ENDIF.
      ENDIF.
      lv_datetime = lo_row_1->get_createdat( ).
      lv_datetime = lo_row_1->get_updatedat( ).
      lv_handshakestatus = lo_row_1->get_status( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

Example for ListChannelHandshakes - START_SERVICE_PERIOD

Example for ListChannelHandshakes - START_SERVICE_PERIOD

DATA(lo_result) = lo_client->listchannelhandshakes(
  io_handshaketypefilters = new /aws1/cl_ptclstchnlhandshake01(
    io_startsvcperiodtypefilters = new /aws1/cl_ptcstrtsvcpertypefi00(
      it_serviceperiodtypes = VALUE /aws1/cl_ptcsvcpertypelist_w=>tt_serviceperiodtypelist(
        ( new /aws1/cl_ptcsvcpertypelist_w( |FIXED_COMMITMENT_PERIOD| ) )
      )
    )
  )
  io_handshaketypesort = new /aws1/cl_ptclstchnlhandshake02(
    io_startsvcperiodtypesort = new /aws1/cl_ptcstrtsvcpertypesort(
      iv_sortby = |UpdatedAt|
      iv_sortorder = |Descending|
    )
  )
  it_associatedresourceids = VALUE /aws1/cl_ptcassocdresidlist_w=>tt_associatedresourceidlist(
    ( new /aws1/cl_ptcassocdresidlist_w( |rs-123abc456def7| ) )
  )
  it_statuses = VALUE /aws1/cl_ptchandshakestatlst_w=>tt_handshakestatuslist(
    ( new /aws1/cl_ptchandshakestatlst_w( |ACCEPTED| ) )
  )
  iv_catalog = |AWS|
  iv_handshaketype = |START_SERVICE_PERIOD|
  iv_participanttype = |SENDER|
).

Example for ListChannelHandshakes - REVOKE_SERVICE_PERIOD

Example for ListChannelHandshakes - REVOKE_SERVICE_PERIOD

DATA(lo_result) = lo_client->listchannelhandshakes(
  io_handshaketypefilters = new /aws1/cl_ptclstchnlhandshake01(
    io_revokesvcpertypefilters = new /aws1/cl_ptcrvksvcpertypefilts(
      it_serviceperiodtypes = VALUE /aws1/cl_ptcsvcpertypelist_w=>tt_serviceperiodtypelist(
        ( new /aws1/cl_ptcsvcpertypelist_w( |MINIMUM_NOTICE_PERIOD| ) )
      )
    )
  )
  io_handshaketypesort = new /aws1/cl_ptclstchnlhandshake02(
    io_revokesvcperiodtypesort = new /aws1/cl_ptcrvkesvcpertypesort(
      iv_sortby = |UpdatedAt|
      iv_sortorder = |Descending|
    )
  )
  it_associatedresourceids = VALUE /aws1/cl_ptcassocdresidlist_w=>tt_associatedresourceidlist(
    ( new /aws1/cl_ptcassocdresidlist_w( |rs-123abc456def7| ) )
  )
  it_statuses = VALUE /aws1/cl_ptchandshakestatlst_w=>tt_handshakestatuslist(
    ( new /aws1/cl_ptchandshakestatlst_w( |ACCEPTED| ) )
  )
  iv_catalog = |AWS|
  iv_handshaketype = |REVOKE_SERVICE_PERIOD|
  iv_participanttype = |SENDER|
).

Example for ListChannelHandshakes - PROGRAM_MANAGEMENT_ACCOUNT

Example for ListChannelHandshakes - PROGRAM_MANAGEMENT_ACCOUNT

DATA(lo_result) = lo_client->listchannelhandshakes(
  io_handshaketypefilters = new /aws1/cl_ptclstchnlhandshake01(
    io_programmngmtaccttypefilts = new /aws1/cl_ptcprogrammgtactype00(
      it_programs = VALUE /aws1/cl_ptcprogramlist_w=>tt_programlist(
        ( new /aws1/cl_ptcprogramlist_w( |SOLUTION_PROVIDER| ) )
      )
    )
  )
  io_handshaketypesort = new /aws1/cl_ptclstchnlhandshake02(
    io_programmngmtaccttypesort = new /aws1/cl_ptcprogrammgtactype01(
      iv_sortby = |UpdatedAt|
      iv_sortorder = |Descending|
    )
  )
  it_associatedresourceids = VALUE /aws1/cl_ptcassocdresidlist_w=>tt_associatedresourceidlist(
    ( new /aws1/cl_ptcassocdresidlist_w( |pma-123abc456def7| ) )
  )
  it_statuses = VALUE /aws1/cl_ptchandshakestatlst_w=>tt_handshakestatuslist(
    ( new /aws1/cl_ptchandshakestatlst_w( |ACCEPTED| ) )
  )
  iv_catalog = |AWS|
  iv_handshaketype = |PROGRAM_MANAGEMENT_ACCOUNT|
  iv_maxresults = 20
  iv_nexttoken = |nextToken|
  iv_participanttype = |SENDER|
).