/AWS1/IF_PTS=>LISTENGAGEMENTS()

About ListEngagements

This action allows users to retrieve a list of Engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process.

Method Signature

METHODS /AWS1/IF_PTS~LISTENGAGEMENTS
  IMPORTING
    !IV_CATALOG TYPE /AWS1/PTSCATALOGIDENTIFIER OPTIONAL
    !IT_CREATEDBY TYPE /AWS1/CL_PTSAWSACCOUNTLIST_W=>TT_AWSACCOUNTLIST OPTIONAL
    !IT_EXCLUDECREATEDBY TYPE /AWS1/CL_PTSAWSACCOUNTLIST_W=>TT_AWSACCOUNTLIST OPTIONAL
    !IT_CONTEXTTYPES TYPE /AWS1/CL_PTSENGAGEMENTCTXTYP00=>TT_ENGAGEMENTCONTEXTTYPELIST OPTIONAL
    !IT_EXCLUDECONTEXTTYPES TYPE /AWS1/CL_PTSENGAGEMENTCTXTYP00=>TT_ENGAGEMENTCONTEXTTYPELIST OPTIONAL
    !IO_SORT TYPE REF TO /AWS1/CL_PTSENGAGEMENTSORT OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PTSENGAGEMENTPAGESIZE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PTSSTRING OPTIONAL
    !IT_ENGAGEMENTIDENTIFIER TYPE /AWS1/CL_PTSENGAGEMENTIDS_W=>TT_ENGAGEMENTIDENTIFIERS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptslistengagementsrsp
  RAISING
    /AWS1/CX_PTSACCESSDENIEDEX
    /AWS1/CX_PTSINTERNALSERVEREX
    /AWS1/CX_PTSRESOURCENOTFOUNDEX
    /AWS1/CX_PTSTHROTTLINGEX
    /AWS1/CX_PTSVALIDATIONEX
    /AWS1/CX_PTSCLIENTEXC
    /AWS1/CX_PTSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_catalog TYPE /AWS1/PTSCATALOGIDENTIFIER /AWS1/PTSCATALOGIDENTIFIER

Specifies the catalog related to the request.

Optional arguments:

it_createdby TYPE /AWS1/CL_PTSAWSACCOUNTLIST_W=>TT_AWSACCOUNTLIST TT_AWSACCOUNTLIST

A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.

it_excludecreatedby TYPE /AWS1/CL_PTSAWSACCOUNTLIST_W=>TT_AWSACCOUNTLIST TT_AWSACCOUNTLIST

An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.

it_contexttypes TYPE /AWS1/CL_PTSENGAGEMENTCTXTYP00=>TT_ENGAGEMENTCONTEXTTYPELIST TT_ENGAGEMENTCONTEXTTYPELIST

Filters engagements to include only those containing the specified context types, such as "CustomerProject" or "Lead". Use this to find engagements that have specific types of contextual information associated with them.

it_excludecontexttypes TYPE /AWS1/CL_PTSENGAGEMENTCTXTYP00=>TT_ENGAGEMENTCONTEXTTYPELIST TT_ENGAGEMENTCONTEXTTYPELIST

Filters engagements to exclude those containing the specified context types. Use this to find engagements that do not have certain types of contextual information, helping to narrow results based on context exclusion criteria.

io_sort TYPE REF TO /AWS1/CL_PTSENGAGEMENTSORT /AWS1/CL_PTSENGAGEMENTSORT

Sort

iv_maxresults TYPE /AWS1/PTSENGAGEMENTPAGESIZE /AWS1/PTSENGAGEMENTPAGESIZE

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

iv_nexttoken TYPE /AWS1/PTSSTRING /AWS1/PTSSTRING

The token for the next set of results. This value is returned from a previous call.

it_engagementidentifier TYPE /AWS1/CL_PTSENGAGEMENTIDS_W=>TT_ENGAGEMENTIDENTIFIERS TT_ENGAGEMENTIDENTIFIERS

An array of strings representing engagement identifiers to retrieve.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptslistengagementsrsp /AWS1/CL_PTSLISTENGAGEMENTSRSP

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->listengagements(
  io_sort = new /aws1/cl_ptsengagementsort(
    iv_sortby = |string|
    iv_sortorder = |string|
  )
  it_contexttypes = VALUE /aws1/cl_ptsengagementctxtyp00=>tt_engagementcontexttypelist(
    ( new /aws1/cl_ptsengagementctxtyp00( |string| ) )
  )
  it_createdby = VALUE /aws1/cl_ptsawsaccountlist_w=>tt_awsaccountlist(
    ( new /aws1/cl_ptsawsaccountlist_w( |string| ) )
  )
  it_engagementidentifier = VALUE /aws1/cl_ptsengagementids_w=>tt_engagementidentifiers(
    ( new /aws1/cl_ptsengagementids_w( |string| ) )
  )
  it_excludecontexttypes = VALUE /aws1/cl_ptsengagementctxtyp00=>tt_engagementcontexttypelist(
    ( new /aws1/cl_ptsengagementctxtyp00( |string| ) )
  )
  it_excludecreatedby = VALUE /aws1/cl_ptsawsaccountlist_w=>tt_awsaccountlist(
    ( new /aws1/cl_ptsawsaccountlist_w( |string| ) )
  )
  iv_catalog = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_engagementsummarylist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_engagementarn = lo_row_1->get_arn( ).
      lv_engagementidentifier = lo_row_1->get_id( ).
      lv_engagementtitle = lo_row_1->get_title( ).
      lv_datetime = lo_row_1->get_createdat( ).
      lv_awsaccount = lo_row_1->get_createdby( ).
      lv_integer = lo_row_1->get_membercount( ).
      lv_datetime = lo_row_1->get_modifiedat( ).
      lv_awsaccount = lo_row_1->get_modifiedby( ).
      LOOP AT lo_row_1->get_contexttypes( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_engagementcontexttype = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.