GETPROSPCTFROMENGAGEMENTTASK()`¶

About GetProspectingFromEngagementTask¶

Retrieves the details and current status of a prospecting task previously started with StartProspectingFromEngagementTask to enable polling for completion and access to per-engagement processing results.

Method Signature¶

METHODS /AWS1/IF_PTS~GETPROSPCTFROMENGAGEMENTTASK
  IMPORTING
    !IV_CATALOG TYPE /AWS1/PTSCATALOGIDENTIFIER OPTIONAL
    !IV_TASKIDENTIFIER TYPE /AWS1/PTSPROSPCTTASKIDENTIFIER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptsgetpspfrmengtskrsp
  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 associated with the task. Specify AWS for production environments and Sandbox for testing and development purposes. The value must match the catalog used when the task was created.

`iv_taskidentifier` `TYPE /AWS1/PTSPROSPCTTASKIDENTIFIER` `/AWS1/PTSPROSPCTTASKIDENTIFIER`¶

The unique identifier of the prospecting task to retrieve. This value is returned in the TaskId field of the StartProspectingFromEngagementTask response.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ptsgetpspfrmengtskrsp` `/AWS1/CL_PTSGETPSPFRMENGTSKRSP`¶

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->getprospctfromengagementtask(
  iv_catalog = |string|
  iv_taskidentifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_prospectingtaskidentifi = lo_result->get_taskid( ).
  lv_prospectingtaskarn = lo_result->get_taskarn( ).
  lv_taskname = lo_result->get_taskname( ).
  lv_datetime = lo_result->get_starttime( ).
  lv_datetime = lo_result->get_endtime( ).
  LOOP AT lo_result->get_engagements( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_engagementidentifier = lo_row_1->get_engagementidentifier( ).
      lv_string = lo_row_1->get_engagementcontextid( ).
      lv_prospectingtaskstatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_reasoncode( ).
      lv_string = lo_row_1->get_message( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_PTS=>GETPROSPCTFROMENGAGEMENTTASK()¶