/AWS1/IF_PTS=>LSTENGAGEMENTBYACCINGINVIT00()

About ListEngagementByAcceptingInvitationTasks

Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account.

Method Signature

METHODS /AWS1/IF_PTS~LSTENGAGEMENTBYACCINGINVIT00
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/PTSINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PTSSTRING OPTIONAL
    !IO_SORT TYPE REF TO /AWS1/CL_PTSLISTTASKSSORTBASE OPTIONAL
    !IV_CATALOG TYPE /AWS1/PTSCATALOGIDENTIFIER OPTIONAL
    !IT_TASKSTATUS TYPE /AWS1/CL_PTSTASKSTATUSES_W=>TT_TASKSTATUSES OPTIONAL
    !IT_OPPORTUNITYIDENTIFIER TYPE /AWS1/CL_PTSOPPORTUNITYIDS_W=>TT_OPPORTUNITYIDENTIFIERS OPTIONAL
    !IT_ENGAGEMENTINVITATIONID00 TYPE /AWS1/CL_PTSENGAGEMENTINVITA03=>TT_ENGAGEMENTINVITATIONIDS OPTIONAL
    !IT_TASKIDENTIFIER TYPE /AWS1/CL_PTSTASKIDENTIFIERS_W=>TT_TASKIDENTIFIERS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptslstengagementbya01
  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. Valid values are:

• AWS: Retrieves the request from the production AWS environment.

• Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.

Optional arguments:

iv_maxresults TYPE /AWS1/PTSINTEGER /AWS1/PTSINTEGER

Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

iv_nexttoken TYPE /AWS1/PTSSTRING /AWS1/PTSSTRING

Use this parameter for pagination when the result set spans multiple pages. This value is obtained from the NextToken field in the response of a previous call to this API.

io_sort TYPE REF TO /AWS1/CL_PTSLISTTASKSSORTBASE /AWS1/CL_PTSLISTTASKSSORTBASE

Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.

it_taskstatus TYPE /AWS1/CL_PTSTASKSTATUSES_W=>TT_TASKSTATUSES TT_TASKSTATUSES

Filters the tasks based on their current status. This allows you to focus on tasks in specific states.

it_opportunityidentifier TYPE /AWS1/CL_PTSOPPORTUNITYIDS_W=>TT_OPPORTUNITYIDENTIFIERS TT_OPPORTUNITYIDENTIFIERS

Filters tasks by the identifiers of the opportunities they created or are associated with.

it_engagementinvitationid00 TYPE /AWS1/CL_PTSENGAGEMENTINVITA03=>TT_ENGAGEMENTINVITATIONIDS TT_ENGAGEMENTINVITATIONIDS

Filters tasks by the identifiers of the engagement invitations they are processing.

it_taskidentifier TYPE /AWS1/CL_PTSTASKIDENTIFIERS_W=>TT_TASKIDENTIFIERS TT_TASKIDENTIFIERS

Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptslstengagementbya01 /AWS1/CL_PTSLSTENGAGEMENTBYA01

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->lstengagementbyaccinginvit00(
  io_sort = new /aws1/cl_ptslisttaskssortbase(
    iv_sortby = |string|
    iv_sortorder = |string|
  )
  it_engagementinvitationid00 = VALUE /aws1/cl_ptsengagementinvita03=>tt_engagementinvitationids(
    ( new /aws1/cl_ptsengagementinvita03( |string| ) )
  )
  it_opportunityidentifier = VALUE /aws1/cl_ptsopportunityids_w=>tt_opportunityidentifiers(
    ( new /aws1/cl_ptsopportunityids_w( |string| ) )
  )
  it_taskidentifier = VALUE /aws1/cl_ptstaskidentifiers_w=>tt_taskidentifiers(
    ( new /aws1/cl_ptstaskidentifiers_w( |string| ) )
  )
  it_taskstatus = VALUE /aws1/cl_ptstaskstatuses_w=>tt_taskstatuses(
    ( new /aws1/cl_ptstaskstatuses_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_tasksummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_taskidentifier = lo_row_1->get_taskid( ).
      lv_taskarn = lo_row_1->get_taskarn( ).
      lv_datetime = lo_row_1->get_starttime( ).
      lv_taskstatus = lo_row_1->get_taskstatus( ).
      lv_string = lo_row_1->get_message( ).
      lv_reasoncode = lo_row_1->get_reasoncode( ).
      lv_opportunityidentifier = lo_row_1->get_opportunityid( ).
      lv_resourcesnapshotjobiden = lo_row_1->get_resourcesnapshotjobid( ).
      lv_engagementinvitationide = lo_row_1->get_engagementinvitationid( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.