SAP CMS_API_RIG_GET_SNG Function Module for Rights GET single (API layer)









CMS_API_RIG_GET_SNG is a standard cms api rig get sng SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Rights GET single (API layer) processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.


See here to view full function module documentation and code listing for cms api rig get sng FM, simply by entering the name CMS_API_RIG_GET_SNG into the relevant SAP transaction such as SE37 or SE38.

Function Group: CMS_API_RIG
Program Name: SAPLCMS_API_RIG
Main Program:
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Normal Function Module
Update:



Function CMS_API_RIG_GET_SNG pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.
CALL FUNCTION 'CMS_API_RIG_GET_SNG'"Rights GET single (API layer)
  EXPORTING
   I_RIG_GUID =  "GUID for  CMS_RIG
*  I_FLG_LOCK =  "Flag:Indicates that the entity needs to be locked
*  I_AST_OBJSYSID =  "Object System Reference ID
*  I_FLG_DB =  "Flag: Indicates that the data is to be fetched from database
*  I_STR_RIG_REQD_DATA =  "Rights required data
*  I_STR_PLANNED_CHANGES =  "Planned Changes

 IMPORTING
   E_STR_RIG_DATA =  "Rights Data
   E_TAB_RIG_SYS_STAT =  "System status of the rights
   E_TAB_RIG_USR_STAT =  "User status for rights
   E_TAB_RC =  "Return Code and corresponding Message
   E_TAB_BP_DATA =  "Business Partner Link  (Get data)
   E_TAB_DOC_DATA =  "Document Service Link (Get data)
   E_TAB_VAL_DATA =  "Value service link (Get data)
   E_STR_RIG_ADDR =  "Address data for rights (Std tab)
   E_TAB_RIG_NOTES =  "Notes data for rights
   E_TAB_RIG_INS_DATA =  "Insurance Data - GET
   E_TAB_RIG_INS_BP_DATA =  "Business Partner Link (Get data)
   E_TAB_RIG_INS_DOC_DATA =  "Document Service Link (Get Data)
.



IMPORTING Parameters details for CMS_API_RIG_GET_SNG

I_RIG_GUID - GUID for CMS_RIG

Data type: CMS_DTE_RIG_GUID
Optional: No
Call by Reference: No ( called with pass by value option)

I_FLG_LOCK - Flag:Indicates that the entity needs to be locked

Data type: CMS_DTE_FLG_LOCK
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_AST_OBJSYSID - Object System Reference ID

Data type: CMS_DTE_OBJ_SYSID
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_FLG_DB - Flag: Indicates that the data is to be fetched from database

Data type: CMS_DTE_FLG_FETCH_FROM_DB
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_STR_RIG_REQD_DATA - Rights required data

Data type: CMS_STR_RIG_REQD_DATA
Optional: Yes
Call by Reference: No ( called with pass by value option)

I_STR_PLANNED_CHANGES - Planned Changes

Data type: CMS_STR_OMS_PLANNED_CHANGES
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for CMS_API_RIG_GET_SNG

E_STR_RIG_DATA - Rights Data

Data type: CMS_STR_RIG_GET_DATA_API
Optional: No
Call by Reference: Yes

E_TAB_RIG_SYS_STAT - System status of the rights

Data type: CMS_TAB_RIG_SYS_STAT
Optional: No
Call by Reference: Yes

E_TAB_RIG_USR_STAT - User status for rights

Data type: CMS_TAB_RIG_USR_STAT
Optional: No
Call by Reference: Yes

E_TAB_RC - Return Code and corresponding Message

Data type: CMS_TAB_MSG_COL_MESSAGE
Optional: No
Call by Reference: Yes

E_TAB_BP_DATA - Business Partner Link (Get data)

Data type: CMS_TAB_OMS_BP_LNK_GET_DATA
Optional: No
Call by Reference: Yes

E_TAB_DOC_DATA - Document Service Link (Get data)

Data type: CMS_TAB_OMS_DOC_LNK_GET_DATA
Optional: No
Call by Reference: Yes

E_TAB_VAL_DATA - Value service link (Get data)

Data type: CMS_TAB_OMS_VAL_LNK_GET_DATA
Optional: No
Call by Reference: Yes

E_STR_RIG_ADDR - Address data for rights (Std tab)

Data type: CMS_STR_RIG_ADDR_DATA
Optional: No
Call by Reference: Yes

E_TAB_RIG_NOTES - Notes data for rights

Data type: CMS_TAB_RIG_TXT_LINES
Optional: No
Call by Reference: Yes

E_TAB_RIG_INS_DATA - Insurance Data - GET

Data type: CMS_TAB_OMS_INS_DATA_GET
Optional: No
Call by Reference: Yes

E_TAB_RIG_INS_BP_DATA - Business Partner Link (Get data)

Data type: CMS_TAB_OMS_BP_LNK_GET_DATA
Optional: No
Call by Reference: Yes

E_TAB_RIG_INS_DOC_DATA - Document Service Link (Get Data)

Data type: CMS_TAB_OMS_DOC_LNK_GET_DATA
Optional: No
Call by Reference: Yes

Copy and paste ABAP code example for CMS_API_RIG_GET_SNG Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the newer method of declaring data variables on the fly. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8), which i why i have stuck to the origianl for this example.

DATA:
lv_i_rig_guid  TYPE CMS_DTE_RIG_GUID, "   
lv_e_str_rig_data  TYPE CMS_STR_RIG_GET_DATA_API, "   
lv_e_tab_rig_sys_stat  TYPE CMS_TAB_RIG_SYS_STAT, "   
lv_e_tab_rig_usr_stat  TYPE CMS_TAB_RIG_USR_STAT, "   
lv_e_tab_rc  TYPE CMS_TAB_MSG_COL_MESSAGE, "   
lv_i_flg_lock  TYPE CMS_DTE_FLG_LOCK, "   
lv_e_tab_bp_data  TYPE CMS_TAB_OMS_BP_LNK_GET_DATA, "   
lv_e_tab_doc_data  TYPE CMS_TAB_OMS_DOC_LNK_GET_DATA, "   
lv_i_ast_objsysid  TYPE CMS_DTE_OBJ_SYSID, "   
lv_i_flg_db  TYPE CMS_DTE_FLG_FETCH_FROM_DB, "   
lv_e_tab_val_data  TYPE CMS_TAB_OMS_VAL_LNK_GET_DATA, "   
lv_e_str_rig_addr  TYPE CMS_STR_RIG_ADDR_DATA, "   
lv_i_str_rig_reqd_data  TYPE CMS_STR_RIG_REQD_DATA, "   
lv_e_tab_rig_notes  TYPE CMS_TAB_RIG_TXT_LINES, "   
lv_i_str_planned_changes  TYPE CMS_STR_OMS_PLANNED_CHANGES, "   
lv_e_tab_rig_ins_data  TYPE CMS_TAB_OMS_INS_DATA_GET, "   
lv_e_tab_rig_ins_bp_data  TYPE CMS_TAB_OMS_BP_LNK_GET_DATA, "   
lv_e_tab_rig_ins_doc_data  TYPE CMS_TAB_OMS_DOC_LNK_GET_DATA. "   

  CALL FUNCTION 'CMS_API_RIG_GET_SNG'  "Rights GET single (API layer)
    EXPORTING
         I_RIG_GUID = lv_i_rig_guid
         I_FLG_LOCK = lv_i_flg_lock
         I_AST_OBJSYSID = lv_i_ast_objsysid
         I_FLG_DB = lv_i_flg_db
         I_STR_RIG_REQD_DATA = lv_i_str_rig_reqd_data
         I_STR_PLANNED_CHANGES = lv_i_str_planned_changes
    IMPORTING
         E_STR_RIG_DATA = lv_e_str_rig_data
         E_TAB_RIG_SYS_STAT = lv_e_tab_rig_sys_stat
         E_TAB_RIG_USR_STAT = lv_e_tab_rig_usr_stat
         E_TAB_RC = lv_e_tab_rc
         E_TAB_BP_DATA = lv_e_tab_bp_data
         E_TAB_DOC_DATA = lv_e_tab_doc_data
         E_TAB_VAL_DATA = lv_e_tab_val_data
         E_STR_RIG_ADDR = lv_e_str_rig_addr
         E_TAB_RIG_NOTES = lv_e_tab_rig_notes
         E_TAB_RIG_INS_DATA = lv_e_tab_rig_ins_data
         E_TAB_RIG_INS_BP_DATA = lv_e_tab_rig_ins_bp_data
         E_TAB_RIG_INS_DOC_DATA = lv_e_tab_rig_ins_doc_data
. " CMS_API_RIG_GET_SNG




ABAP code using 7.40 inline data declarations to call FM CMS_API_RIG_GET_SNG

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!