SAP BAPI_RELHSRVAPS_GETLIST Function Module for Read Location Hierarchies for Selection Criteria









BAPI_RELHSRVAPS_GETLIST is a standard bapi relhsrvaps getlist SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Read Location Hierarchies for Selection Criteria 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 bapi relhsrvaps getlist FM, simply by entering the name BAPI_RELHSRVAPS_GETLIST into the relevant SAP transaction such as SE37 or SE38.

Function Group: APO_RELH
Program Name: SAPLAPO_RELH
Main Program: SAPLAPO_RELH
Appliation area:
Release date: N/A
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function BAPI_RELHSRVAPS_GETLIST 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 'BAPI_RELHSRVAPS_GETLIST'"Read Location Hierarchies for Selection Criteria
  EXPORTING
*  MODEL = '000' "Model Name in Supply Chain Network
*  NODE_SELECT = '1' "Selection Type for Hierarchy Nodes
   LOGICAL_SYSTEM =  "Logical System from which Message Originates
*  PLANNING_VERSION = '000' "Planning Version
*  BUSINESS_SYSTEM_GROUP =  "Business System Group
*  FROM_LEVEL = '000' "Level Sequence Number for Object Hierarchies
*  TO_LEVEL = '999' "Level Sequence Number for Object Hierarchies
*  EXCLUDE_EXPORT_FLAGS =  "Restriction of Return Tables to be Filled
*  MAX_NO_OF_HIERARCHIES =  "Number of Entries Found for a Selection
*  MAX_NO_OF_NODES =  "Number of Entries Found for a Selection

 IMPORTING
   NUMBER_OF_HIERARCHIES =  "Number of Entries Found for a Selection
   NUMBER_OF_NODES =  "Number of Entries Found for a Selection

TABLES
*  HIERARCHY_NAME_SELECTION =  "Selection Criteria for Hierarchy Names (RANGES Table)
*  HIERARCHY_HEAD_TEXT =  "Hierarchy: Header Entry Short Texts (Return Structure)
*  HIERARCHY_STR_HEAD =  "Hierarchy Structure Header Entry (Return Structure)
*  HIERARCHY_STR_HEAD_TEXT =  "Hierarchy Structure Header Entry Short Texts (Return Structure)
*  HIERARCHY_STR_LEVEL =  "Hierarchy Structure Level Assignment (Return Structure)
*  HIERARCHY_STR_LEVEL_TEXT =  "Hierarchy Structure Level Assignment Texts (Return Structure)
*  HIERARCHY_NODES =  "Nodes of a Hierarchy (Return Structure)
*  RETURN =  "Return Parameter
*  EXTENSION_IN =  "Reference Structure for BAPI Parameters ExtensionIn/ExtensionOut
*  EXTENSION_OUT =  "Reference Structure for BAPI Parameters ExtensionIn/ExtensionOut
*  HIERARCHY_STRUCT_SELECTION =  "Selection Criteria for Hierarchy Structure Names (RANGES)
*  HIERARCHY_STRUCT_TYPE =  "Selection Criteria for Hierarchy Types (RANGES Table)
*  HIERARCHY_NODE_TYPE =  "Selection Criteria for Hierarchy Node Type (RANGES Table)
*  NODE_GUIDS =  "Node ID (GUID) with Node Type for Hierarchies
*  LOCATION_SELECTION =  "RANGES Table for Locations
*  LOCTYPE_SELECTION =  "RANGES Table for Location Types
*  LOCATION_KEYS =  "Location Key
*  HIERARCHY_HEAD =  "Hierarchy: Header Entry (Return Structure)
.



IMPORTING Parameters details for BAPI_RELHSRVAPS_GETLIST

MODEL - Model Name in Supply Chain Network

Data type: BAPIGENFIELDS-MODELID
Default: '000'
Optional: Yes
Call by Reference: No ( called with pass by value option)

NODE_SELECT - Selection Type for Hierarchy Nodes

Data type: BAPIRELHGENFIELDS-NODE_SEL
Default: '1'
Optional: Yes
Call by Reference: No ( called with pass by value option)

LOGICAL_SYSTEM - Logical System from which Message Originates

Data type: BAPIGENFIELDS-LOGSYSTEM
Optional: No
Call by Reference: No ( called with pass by value option)

PLANNING_VERSION - Planning Version

Data type: BAPIGENFIELDS-VRSIOEX
Default: '000'
Optional: Yes
Call by Reference: No ( called with pass by value option)

BUSINESS_SYSTEM_GROUP - Business System Group

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

FROM_LEVEL - Level Sequence Number for Object Hierarchies

Data type: BAPIRELHGENFIELDS-FROM_LEVEL
Default: '000'
Optional: Yes
Call by Reference: No ( called with pass by value option)

TO_LEVEL - Level Sequence Number for Object Hierarchies

Data type: BAPIRELHGENFIELDS-TO_LEVEL
Default: '999'
Optional: Yes
Call by Reference: No ( called with pass by value option)

EXCLUDE_EXPORT_FLAGS - Restriction of Return Tables to be Filled

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

MAX_NO_OF_HIERARCHIES - Number of Entries Found for a Selection

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

MAX_NO_OF_NODES - Number of Entries Found for a Selection

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

EXPORTING Parameters details for BAPI_RELHSRVAPS_GETLIST

NUMBER_OF_HIERARCHIES - Number of Entries Found for a Selection

Data type: BAPIGENFIELDS-SEL_ROWS
Optional: No
Call by Reference: No ( called with pass by value option)

NUMBER_OF_NODES - Number of Entries Found for a Selection

Data type: BAPIGENFIELDS-SEL_ROWS
Optional: No
Call by Reference: No ( called with pass by value option)

TABLES Parameters details for BAPI_RELHSRVAPS_GETLIST

HIERARCHY_NAME_SELECTION - Selection Criteria for Hierarchy Names (RANGES Table)

Data type: BAPIRELHRANGE
Optional: Yes
Call by Reference: Yes

HIERARCHY_HEAD_TEXT - Hierarchy: Header Entry Short Texts (Return Structure)

Data type: BAPIRELHEADTEXTOUT
Optional: Yes
Call by Reference: Yes

HIERARCHY_STR_HEAD - Hierarchy Structure Header Entry (Return Structure)

Data type: BAPIRELHSTRHEADOUT
Optional: Yes
Call by Reference: Yes

HIERARCHY_STR_HEAD_TEXT - Hierarchy Structure Header Entry Short Texts (Return Structure)

Data type: BAPIRELHSTRHEADTEXTOUT
Optional: Yes
Call by Reference: Yes

HIERARCHY_STR_LEVEL - Hierarchy Structure Level Assignment (Return Structure)

Data type: BAPIRELHSTRLEVELOUT
Optional: Yes
Call by Reference: Yes

HIERARCHY_STR_LEVEL_TEXT - Hierarchy Structure Level Assignment Texts (Return Structure)

Data type: BAPIRELHSTRLEVELTEXTOUT
Optional: Yes
Call by Reference: Yes

HIERARCHY_NODES - Nodes of a Hierarchy (Return Structure)

Data type: BAPIRELHNODESOUT
Optional: Yes
Call by Reference: Yes

RETURN - Return Parameter

Data type: BAPIRET2
Optional: Yes
Call by Reference: Yes

EXTENSION_IN - Reference Structure for BAPI Parameters ExtensionIn/ExtensionOut

Data type: BAPIPAREX
Optional: Yes
Call by Reference: Yes

EXTENSION_OUT - Reference Structure for BAPI Parameters ExtensionIn/ExtensionOut

Data type: BAPIPAREX
Optional: Yes
Call by Reference: Yes

HIERARCHY_STRUCT_SELECTION - Selection Criteria for Hierarchy Structure Names (RANGES)

Data type: BAPIRELHSTRUCT
Optional: Yes
Call by Reference: Yes

HIERARCHY_STRUCT_TYPE - Selection Criteria for Hierarchy Types (RANGES Table)

Data type: BAPIRELHSTRUCTYPE
Optional: Yes
Call by Reference: Yes

HIERARCHY_NODE_TYPE - Selection Criteria for Hierarchy Node Type (RANGES Table)

Data type: BAPIRELHNODE
Optional: Yes
Call by Reference: Yes

NODE_GUIDS - Node ID (GUID) with Node Type for Hierarchies

Data type: BAPIRELHGUIDS
Optional: Yes
Call by Reference: Yes

LOCATION_SELECTION - RANGES Table for Locations

Data type: BAPILOCRANGE
Optional: Yes
Call by Reference: Yes

LOCTYPE_SELECTION - RANGES Table for Location Types

Data type: BAPILOCTYPERANGE
Optional: Yes
Call by Reference: Yes

LOCATION_KEYS - Location Key

Data type: BAPI10002KEY
Optional: Yes
Call by Reference: Yes

HIERARCHY_HEAD - Hierarchy: Header Entry (Return Structure)

Data type: BAPIRELHEADOUT
Optional: Yes
Call by Reference: Yes

Copy and paste ABAP code example for BAPI_RELHSRVAPS_GETLIST 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_model  TYPE BAPIGENFIELDS-MODELID, "   '000'
lv_number_of_hierarchies  TYPE BAPIGENFIELDS-SEL_ROWS, "   
lt_hierarchy_name_selection  TYPE STANDARD TABLE OF BAPIRELHRANGE, "   
lv_node_select  TYPE BAPIRELHGENFIELDS-NODE_SEL, "   '1'
lt_hierarchy_head_text  TYPE STANDARD TABLE OF BAPIRELHEADTEXTOUT, "   
lt_hierarchy_str_head  TYPE STANDARD TABLE OF BAPIRELHSTRHEADOUT, "   
lt_hierarchy_str_head_text  TYPE STANDARD TABLE OF BAPIRELHSTRHEADTEXTOUT, "   
lt_hierarchy_str_level  TYPE STANDARD TABLE OF BAPIRELHSTRLEVELOUT, "   
lt_hierarchy_str_level_text  TYPE STANDARD TABLE OF BAPIRELHSTRLEVELTEXTOUT, "   
lt_hierarchy_nodes  TYPE STANDARD TABLE OF BAPIRELHNODESOUT, "   
lt_return  TYPE STANDARD TABLE OF BAPIRET2, "   
lt_extension_in  TYPE STANDARD TABLE OF BAPIPAREX, "   
lt_extension_out  TYPE STANDARD TABLE OF BAPIPAREX, "   
lv_logical_system  TYPE BAPIGENFIELDS-LOGSYSTEM, "   
lv_number_of_nodes  TYPE BAPIGENFIELDS-SEL_ROWS, "   
lt_hierarchy_struct_selection  TYPE STANDARD TABLE OF BAPIRELHSTRUCT, "   
lv_planning_version  TYPE BAPIGENFIELDS-VRSIOEX, "   '000'
lt_hierarchy_struct_type  TYPE STANDARD TABLE OF BAPIRELHSTRUCTYPE, "   
lt_hierarchy_node_type  TYPE STANDARD TABLE OF BAPIRELHNODE, "   
lv_business_system_group  TYPE BAPIGENFIELDS-BUSGROUP, "   
lv_from_level  TYPE BAPIRELHGENFIELDS-FROM_LEVEL, "   '000'
lt_node_guids  TYPE STANDARD TABLE OF BAPIRELHGUIDS, "   
lv_to_level  TYPE BAPIRELHGENFIELDS-TO_LEVEL, "   '999'
lt_location_selection  TYPE STANDARD TABLE OF BAPILOCRANGE, "   
lt_loctype_selection  TYPE STANDARD TABLE OF BAPILOCTYPERANGE, "   
lv_exclude_export_flags  TYPE BAPIRELHSELRETFLAGS, "   
lt_location_keys  TYPE STANDARD TABLE OF BAPI10002KEY, "   
lv_max_no_of_hierarchies  TYPE BAPIGENFIELDS-SEL_ROWS, "   
lt_hierarchy_head  TYPE STANDARD TABLE OF BAPIRELHEADOUT, "   
lv_max_no_of_nodes  TYPE BAPIGENFIELDS-SEL_ROWS. "   

  CALL FUNCTION 'BAPI_RELHSRVAPS_GETLIST'  "Read Location Hierarchies for Selection Criteria
    EXPORTING
         MODEL = lv_model
         NODE_SELECT = lv_node_select
         LOGICAL_SYSTEM = lv_logical_system
         PLANNING_VERSION = lv_planning_version
         BUSINESS_SYSTEM_GROUP = lv_business_system_group
         FROM_LEVEL = lv_from_level
         TO_LEVEL = lv_to_level
         EXCLUDE_EXPORT_FLAGS = lv_exclude_export_flags
         MAX_NO_OF_HIERARCHIES = lv_max_no_of_hierarchies
         MAX_NO_OF_NODES = lv_max_no_of_nodes
    IMPORTING
         NUMBER_OF_HIERARCHIES = lv_number_of_hierarchies
         NUMBER_OF_NODES = lv_number_of_nodes
    TABLES
         HIERARCHY_NAME_SELECTION = lt_hierarchy_name_selection
         HIERARCHY_HEAD_TEXT = lt_hierarchy_head_text
         HIERARCHY_STR_HEAD = lt_hierarchy_str_head
         HIERARCHY_STR_HEAD_TEXT = lt_hierarchy_str_head_text
         HIERARCHY_STR_LEVEL = lt_hierarchy_str_level
         HIERARCHY_STR_LEVEL_TEXT = lt_hierarchy_str_level_text
         HIERARCHY_NODES = lt_hierarchy_nodes
         RETURN = lt_return
         EXTENSION_IN = lt_extension_in
         EXTENSION_OUT = lt_extension_out
         HIERARCHY_STRUCT_SELECTION = lt_hierarchy_struct_selection
         HIERARCHY_STRUCT_TYPE = lt_hierarchy_struct_type
         HIERARCHY_NODE_TYPE = lt_hierarchy_node_type
         NODE_GUIDS = lt_node_guids
         LOCATION_SELECTION = lt_location_selection
         LOCTYPE_SELECTION = lt_loctype_selection
         LOCATION_KEYS = lt_location_keys
         HIERARCHY_HEAD = lt_hierarchy_head
. " BAPI_RELHSRVAPS_GETLIST




ABAP code using 7.40 inline data declarations to call FM BAPI_RELHSRVAPS_GETLIST

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.

"SELECT single MODELID FROM BAPIGENFIELDS INTO @DATA(ld_model).
DATA(ld_model) = '000'.
 
"SELECT single SEL_ROWS FROM BAPIGENFIELDS INTO @DATA(ld_number_of_hierarchies).
 
 
"SELECT single NODE_SEL FROM BAPIRELHGENFIELDS INTO @DATA(ld_node_select).
DATA(ld_node_select) = '1'.
 
 
 
 
 
 
 
 
 
 
"SELECT single LOGSYSTEM FROM BAPIGENFIELDS INTO @DATA(ld_logical_system).
 
"SELECT single SEL_ROWS FROM BAPIGENFIELDS INTO @DATA(ld_number_of_nodes).
 
 
"SELECT single VRSIOEX FROM BAPIGENFIELDS INTO @DATA(ld_planning_version).
DATA(ld_planning_version) = '000'.
 
 
 
"SELECT single BUSGROUP FROM BAPIGENFIELDS INTO @DATA(ld_business_system_group).
 
"SELECT single FROM_LEVEL FROM BAPIRELHGENFIELDS INTO @DATA(ld_from_level).
DATA(ld_from_level) = '000'.
 
 
"SELECT single TO_LEVEL FROM BAPIRELHGENFIELDS INTO @DATA(ld_to_level).
DATA(ld_to_level) = '999'.
 
 
 
 
 
"SELECT single SEL_ROWS FROM BAPIGENFIELDS INTO @DATA(ld_max_no_of_hierarchies).
 
 
"SELECT single SEL_ROWS FROM BAPIGENFIELDS INTO @DATA(ld_max_no_of_nodes).
 


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!