SAP SO_FOLDER_HIERARCHY_READ_API1 Function Module for SAPoffice: View folder structure using API1

Search SAP Function Modules

SO_FOLDER_HIERARCHY_READ_API1 is a standard so folder hierarchy read api1 SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for SAPoffice: View folder structure using API1 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 so folder hierarchy read api1 FM, simply by entering the name SO_FOLDER_HIERARCHY_READ_API1 into the relevant SAP transaction such as SE37 or SE38.

Function Group: SOI1
Program Name: SAPLSOI1
Main Program: SAPLSOI1
Appliation area: S
Release date: 14-Apr-1998
Mode(Normal, Remote etc): Remote-Enabled
Update:

Function SO_FOLDER_HIERARCHY_READ_API1 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 'SO_FOLDER_HIERARCHY_READ_API1'"SAPoffice: View folder structure using API1
  EXPORTING
   ROOT_FOLDER_ID =  "ID of root folder for folder
*  LAST_ACCESS_DATE = '00000000' "Filter for last access date

TABLES
   FOLDER_HIERARCHY_TABLE =  "Folder hierarchy table

EXCEPTIONS
   FOLDER_NOT_EXIST = 1    OPERATION_NO_AUTHORIZATION = 2    PARAMETER_ERROR = 3    X_ERROR = 4 

.

IMPORTING Parameters details for SO_FOLDER_HIERARCHY_READ_API1

ROOT_FOLDER_ID - ID of root folder for folder

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

LAST_ACCESS_DATE - Filter for last access date

Data type: SOFOLHIRI1-LAST_ACCES
Default: '00000000'
Optional: Yes
Call by Reference: No ( called with pass by value option)

TABLES Parameters details for SO_FOLDER_HIERARCHY_READ_API1

FOLDER_HIERARCHY_TABLE - Folder hierarchy table

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

EXCEPTIONS details

FOLDER_NOT_EXIST - Specified root folder does not exist

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

OPERATION_NO_AUTHORIZATION - No authorization to view hierarchy

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

PARAMETER_ERROR - Invalid combination of parameter values

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

X_ERROR - Internal error or database inconsistency

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

Copy and paste ABAP code example for SO_FOLDER_HIERARCHY_READ_API1 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.

ABAP code using 7.40 inline data declarations to call FM SO_FOLDER_HIERARCHY_READ_API1

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