Skip to content

/AWS1/IF_SAG=>CREATEMEMBERSHIP()

About CreateMembership

Creates a new membership, granting a user access to an agent space within an application.

Method Signature

METHODS /AWS1/IF_SAG~CREATEMEMBERSHIP
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/SAGAPPLICATIONID OPTIONAL
    !IV_AGENTSPACEID TYPE /AWS1/SAGAGENTSPACEID OPTIONAL
    !IV_MEMBERSHIPID TYPE /AWS1/SAGMEMBERSHIPID OPTIONAL
    !IV_MEMBERTYPE TYPE /AWS1/SAGMEMBERSHIPTYPE OPTIONAL
    !IO_CONFIG TYPE REF TO /AWS1/CL_SAGMEMBERSHIPCONFIG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sagcreatemembshprsp
  RAISING
    /AWS1/CX_SAGCLIENTEXC
    /AWS1/CX_SAGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/SAGAPPLICATIONID /AWS1/SAGAPPLICATIONID

The unique identifier of the application that contains the agent space.

iv_agentspaceid TYPE /AWS1/SAGAGENTSPACEID /AWS1/SAGAGENTSPACEID

The unique identifier of the agent space to grant access to.

iv_membershipid TYPE /AWS1/SAGMEMBERSHIPID /AWS1/SAGMEMBERSHIPID

The unique identifier for the membership.

iv_membertype TYPE /AWS1/SAGMEMBERSHIPTYPE /AWS1/SAGMEMBERSHIPTYPE

The type of member. Currently, only USER is supported.

Optional arguments:

io_config TYPE REF TO /AWS1/CL_SAGMEMBERSHIPCONFIG /AWS1/CL_SAGMEMBERSHIPCONFIG

The configuration for the membership, such as the user role.

RETURNING

oo_output TYPE REF TO /aws1/cl_sagcreatemembshprsp /AWS1/CL_SAGCREATEMEMBSHPRSP

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->createmembership(
  io_config = new /aws1/cl_sagmembershipconfig( new /aws1/cl_saguserconfig( |string| ) )
  iv_agentspaceid = |string|
  iv_applicationid = |string|
  iv_membershipid = |string|
  iv_membertype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.