Skip to content

/AWS1/CL_PTS=>LISTENGAGEMENTINVITATIONS()

About ListEngagementInvitations

Retrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track opportunities shared by AWS.

Method Signature

IMPORTING

Required arguments:

iv_catalog TYPE /AWS1/PTSCATALOGIDENTIFIER /AWS1/PTSCATALOGIDENTIFIER

Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.

iv_participanttype TYPE /AWS1/PTSPARTICIPANTTYPE /AWS1/PTSPARTICIPANTTYPE

Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.

Optional arguments:

iv_maxresults TYPE /AWS1/PTSPAGESIZE /AWS1/PTSPAGESIZE

Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.

iv_nexttoken TYPE /AWS1/PTSSTRING /AWS1/PTSSTRING

A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.

io_sort TYPE REF TO /AWS1/CL_PTSOPPORTUNITYENGAG00 /AWS1/CL_PTSOPPORTUNITYENGAG00

Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.

it_payloadtype TYPE /AWS1/CL_PTSENGAGEMENTINVITA00=>TT_ENGAGEMENTINVITATIONSPAYL00 TT_ENGAGEMENTINVITATIONSPAYL00

Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.

it_status TYPE /AWS1/CL_PTSINVITATIONSTATLS00=>TT_INVITATIONSTATUSLIST TT_INVITATIONSTATUSLIST

Status values to filter the invitations.

it_engagementidentifier TYPE /AWS1/CL_PTSENGAGEMENTIDS_W=>TT_ENGAGEMENTIDENTIFIERS TT_ENGAGEMENTIDENTIFIERS

Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.

it_senderawsaccountid TYPE /AWS1/CL_PTSAWSACIDORALIASLS00=>TT_AWSACCOUNTIDORALIASLIST TT_AWSACCOUNTIDORALIASLIST

List of sender AWS account IDs to filter the invitations.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptslstengagementinv01 /AWS1/CL_PTSLSTENGAGEMENTINV01

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_pts~listengagementinvitations(
  io_sort = new /aws1/cl_ptsopportunityengag00(
    iv_sortby = |string|
    iv_sortorder = |string|
  )
  it_engagementidentifier = VALUE /aws1/cl_ptsengagementids_w=>tt_engagementidentifiers(
    ( new /aws1/cl_ptsengagementids_w( |string| ) )
  )
  it_payloadtype = VALUE /aws1/cl_ptsengagementinvita00=>tt_engagementinvitationspayl00(
    ( new /aws1/cl_ptsengagementinvita00( |string| ) )
  )
  it_senderawsaccountid = VALUE /aws1/cl_ptsawsacidoraliasls00=>tt_awsaccountidoraliaslist(
    ( new /aws1/cl_ptsawsacidoraliasls00( |string| ) )
  )
  it_status = VALUE /aws1/cl_ptsinvitationstatls00=>tt_invitationstatuslist(
    ( new /aws1/cl_ptsinvitationstatls00( |string| ) )
  )
  iv_catalog = |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_engagementinvitationsums( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_arn( ).
      lv_engagementinvitationpay = lo_row_1->get_payloadtype( ).
      lv_engagementinvitationarn = lo_row_1->get_id( ).
      lv_engagementidentifier = lo_row_1->get_engagementid( ).
      lv_engagementtitle = lo_row_1->get_engagementtitle( ).
      lv_invitationstatus = lo_row_1->get_status( ).
      lv_datetime = lo_row_1->get_invitationdate( ).
      lv_datetime = lo_row_1->get_expirationdate( ).
      lv_awsaccount = lo_row_1->get_senderawsaccountid( ).
      lv_string = lo_row_1->get_sendercompanyname( ).
      lo_receiver = lo_row_1->get_receiver( ).
      IF lo_receiver IS NOT INITIAL.
        lo_accountreceiver = lo_receiver->get_account( ).
        IF lo_accountreceiver IS NOT INITIAL.
          lv_alias = lo_accountreceiver->get_alias( ).
          lv_awsaccount = lo_accountreceiver->get_awsaccountid( ).
        ENDIF.
      ENDIF.
      lv_catalogidentifier = lo_row_1->get_catalog( ).
      lv_participanttype = lo_row_1->get_participanttype( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.