CREATEENGAGEMENTINVITATION()`¶

About CreateEngagementInvitation¶

This action creates an invitation from a sender to a single receiver to join an engagement.

Method Signature¶

METHODS /AWS1/IF_PTS~CREATEENGAGEMENTINVITATION
  IMPORTING
    !IV_CATALOG TYPE /AWS1/PTSCATALOGIDENTIFIER OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/PTSCLIENTTOKEN OPTIONAL
    !IV_ENGAGEMENTIDENTIFIER TYPE /AWS1/PTSENGAGEMENTIDENTIFIER OPTIONAL
    !IO_INVITATION TYPE REF TO /AWS1/CL_PTSINVITATION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptscreengagementinv01
  RAISING
    /AWS1/CX_PTSACCESSDENIEDEX
    /AWS1/CX_PTSCONFLICTEXCEPTION
    /AWS1/CX_PTSINTERNALSERVEREX
    /AWS1/CX_PTSRESOURCENOTFOUNDEX
    /AWS1/CX_PTSSERVICEQUOTAEXCDEX
    /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. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.

`iv_clienttoken` `TYPE /AWS1/PTSCLIENTTOKEN` `/AWS1/PTSCLIENTTOKEN`¶

Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.

`iv_engagementidentifier` `TYPE /AWS1/PTSENGAGEMENTIDENTIFIER` `/AWS1/PTSENGAGEMENTIDENTIFIER`¶

The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.

`io_invitation` `TYPE REF TO /AWS1/CL_PTSINVITATION` `/AWS1/CL_PTSINVITATION`¶

The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details, or LeadInvitation, which includes structures for customer information and interaction details.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ptscreengagementinv01` `/AWS1/CL_PTSCREENGAGEMENTINV01`¶

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->createengagementinvitation(
  io_invitation = new /aws1/cl_ptsinvitation(
    io_payload = new /aws1/cl_ptspayload(
      io_leadinvitation = new /aws1/cl_ptsleadinvtnpayload(
        io_customer = new /aws1/cl_ptsleadinvtncustomer(
          iv_awsmaturity = |string|
          iv_companyname = |string|
          iv_countrycode = |string|
          iv_industry = |string|
          iv_marketsegment = |string|
          iv_websiteurl = |string|
        )
        io_interaction = new /aws1/cl_ptsleadinvtninteract(
          iv_contactbusinesstitle = |string|
          iv_sourceid = |string|
          iv_sourcename = |string|
          iv_sourcetype = |string|
          iv_usecase = |string|
        )
      )
      io_opportunityinvitation = new /aws1/cl_ptsopportunityinvit00(
        io_customer = new /aws1/cl_ptsengagementcustomer(
          iv_companyname = |string|
          iv_countrycode = |string|
          iv_industry = |string|
          iv_websiteurl = |string|
        )
        io_project = new /aws1/cl_ptsprojectdetails(
          it_expectedcustomerspend = VALUE /aws1/cl_ptsexpectedcusspend=>tt_expectedcustomerspendlist(
            (
              new /aws1/cl_ptsexpectedcusspend(
                iv_amount = |string|
                iv_currencycode = |string|
                iv_estimationurl = |string|
                iv_frequency = |string|
                iv_targetcompany = |string|
              )
            )
          )
          iv_businessproblem = |string|
          iv_targetcompletiondate = |string|
          iv_title = |string|
        )
        it_receiverresponsibilities = VALUE /aws1/cl_ptsreceiverresponsi00=>tt_receiverresponsibilitylist(
          ( new /aws1/cl_ptsreceiverresponsi00( |string| ) )
        )
        it_sendercontacts = VALUE /aws1/cl_ptssendercontact=>tt_sendercontactlist(
          (
            new /aws1/cl_ptssendercontact(
              iv_businesstitle = |string|
              iv_email = |string|
              iv_firstname = |string|
              iv_lastname = |string|
              iv_phone = |string|
            )
          )
        )
      )
    )
    io_receiver = new /aws1/cl_ptsreceiver(
      io_account = new /aws1/cl_ptsaccountreceiver(
        iv_alias = |string|
        iv_awsaccountid = |string|
      )
    )
    iv_message = |string|
  )
  iv_catalog = |string|
  iv_clienttoken = |string|
  iv_engagementidentifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_engagementinvitationide = lo_result->get_id( ).
  lv_engagementinvitationarn = lo_result->get_arn( ).
ENDIF.

/AWS1/IF_PTS=>CREATEENGAGEMENTINVITATION()¶