/AWS1/IF_PTS=>GETENGAGEMENT()

About GetEngagement

Use this action to retrieve the engagement record for a given EngagementIdentifier.

Method Signature

METHODS /AWS1/IF_PTS~GETENGAGEMENT
  IMPORTING
    !IV_CATALOG TYPE /AWS1/PTSCATALOGIDENTIFIER OPTIONAL
    !IV_IDENTIFIER TYPE /AWS1/PTSENGAGEMENTARNORID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptsgetengagementrsp
  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 engagement request. Valid values are AWS and Sandbox.

iv_identifier TYPE /AWS1/PTSENGAGEMENTARNORID /AWS1/PTSENGAGEMENTARNORID

Specifies the identifier of the Engagement record to retrieve.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptsgetengagementrsp /AWS1/CL_PTSGETENGAGEMENTRSP

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->getengagement(
  iv_catalog = |string|
  iv_identifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_engagementidentifier = lo_result->get_id( ).
  lv_engagementarn = lo_result->get_arn( ).
  lv_engagementtitle = lo_result->get_title( ).
  lv_engagementdescription = lo_result->get_description( ).
  lv_datetime = lo_result->get_createdat( ).
  lv_awsaccount = lo_result->get_createdby( ).
  lv_integer = lo_result->get_membercount( ).
  lv_datetime = lo_result->get_modifiedat( ).
  lv_awsaccount = lo_result->get_modifiedby( ).
  LOOP AT lo_result->get_contexts( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_engagementcontextidenti = lo_row_1->get_id( ).
      lv_engagementcontexttype = lo_row_1->get_type( ).
      lo_engagementcontextpayloa = lo_row_1->get_payload( ).
      IF lo_engagementcontextpayloa IS NOT INITIAL.
        lo_customerprojectscontext = lo_engagementcontextpayloa->get_customerproject( ).
        IF lo_customerprojectscontext IS NOT INITIAL.
          lo_engagementcustomer = lo_customerprojectscontext->get_customer( ).
          IF lo_engagementcustomer IS NOT INITIAL.
            lv_industry = lo_engagementcustomer->get_industry( ).
            lv_companyname = lo_engagementcustomer->get_companyname( ).
            lv_companywebsiteurl = lo_engagementcustomer->get_websiteurl( ).
            lv_countrycode = lo_engagementcustomer->get_countrycode( ).
          ENDIF.
          lo_engagementcustomerproje = lo_customerprojectscontext->get_project( ).
          IF lo_engagementcustomerproje IS NOT INITIAL.
            lv_engagementcustomerproje_1 = lo_engagementcustomerproje->get_title( ).
            lv_engagementcustomerbusin = lo_engagementcustomerproje->get_businessproblem( ).
            lv_string = lo_engagementcustomerproje->get_targetcompletiondate( ).
          ENDIF.
        ENDIF.
        lo_leadcontext = lo_engagementcontextpayloa->get_lead( ).
        IF lo_leadcontext IS NOT INITIAL.
          lv_leadqualificationstatus = lo_leadcontext->get_qualificationstatus( ).
          lo_leadcustomer = lo_leadcontext->get_customer( ).
          IF lo_leadcustomer IS NOT INITIAL.
            lv_industry = lo_leadcustomer->get_industry( ).
            lv_companyname = lo_leadcustomer->get_companyname( ).
            lv_companywebsiteurl = lo_leadcustomer->get_websiteurl( ).
            lo_addresssummary = lo_leadcustomer->get_address( ).
            IF lo_addresssummary IS NOT INITIAL.
              lv_addresspart = lo_addresssummary->get_city( ).
              lv_addresspart = lo_addresssummary->get_postalcode( ).
              lv_addresspart = lo_addresssummary->get_stateorregion( ).
              lv_countrycode = lo_addresssummary->get_countrycode( ).
            ENDIF.
            lv_awsmaturity = lo_leadcustomer->get_awsmaturity( ).
            lv_marketsegment = lo_leadcustomer->get_marketsegment( ).
          ENDIF.
          LOOP AT lo_leadcontext->get_interactions( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_leadsourcetype = lo_row_3->get_sourcetype( ).
              lv_leadsourceid = lo_row_3->get_sourceid( ).
              lv_leadsourcename = lo_row_3->get_sourcename( ).
              lv_engagementusecase = lo_row_3->get_usecase( ).
              lv_datetime = lo_row_3->get_interactiondate( ).
              lv_customeraction = lo_row_3->get_customeraction( ).
              lv_engagementcustomerbusin = lo_row_3->get_businessproblem( ).
              lo_leadcontact = lo_row_3->get_contact( ).
              IF lo_leadcontact IS NOT INITIAL.
                lv_jobtitle = lo_leadcontact->get_businesstitle( ).
                lv_email = lo_leadcontact->get_email( ).
                lv_name = lo_leadcontact->get_firstname( ).
                lv_name = lo_leadcontact->get_lastname( ).
                lv_phonenumber = lo_leadcontact->get_phone( ).
              ENDIF.
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.