SAP® Documentation

Single view

Business Application Programming Interfaces (BAPIs) ( RELN46A_CA_BFA_API )

General Material Data   CPI1466 during Backup  
This documentation is copyright by SAP AG.
SAP E-Book

Short text

Business Application Programming Interfaces (BAPIs)

Scope of Functions

BAPIs (Business Application Programming Interfaces) are open, business-oriented programming interfaces that can be used by external systems to access business processes and data in the R/3 System.

BAPIs are defined in the Business Object Repository (BOR) as methods of SAP business object types or of SAP interface types. BAPIs enable an object-oriented view of the R/3 business components (application components).

You can find more information on BAPI interface technology refer to the BAPI Programming Guide and the BAPI User Guide in the R/3 Library under:

CA - Cross-Application Components

- Business Framework Architecture

- BAPI Technology

In Release 4.6A new developments are:

  • BAPI Explorer
    The BAPI development environment has been enhanced with the BAPI Explorer - the integrated programming environment for developing BAPIs and using BAPIs in your developments.
Application developers can use the BAPI Explorer to find out which BAPIs are available for use. You can display the BAPIs either in alphabetical order or by the associated object type or interface type in the BOR component hierarchy. The BAPI Explorer contains all the information required to use any of the BAPIs.
Customers and partners as well as SAP developers can use the BAPI Explorer to develop BAPIs. The BAPI Explorer is an integrated programming environment providing all the tools to create BAPIs and the required development objects. The entire development process of BAPIs is carried out in form-controlled projects to achieve maximum quality, stability and user-friendliness.
  • Use of Application Logs
As of Release 4.6A you can obtain the log number at the time you create the application log. Several instances of an application object can be managed at the same time and updated together.
The update process can be used for application logs, that is, log entries are now written to the database via the update task, and no longer written directly. If you plan to use application logs in BAPIs, they must be written using an update task.
  • BAPIs with Buffering
    To save external systems from having to use their own data buffering, buffering mechanisms can be implemented in all write BAPIs - those that create or change data.

  • Central Service BAPIs
The service BAPIs of the business objects HelpValues and BapiService are now included in the BOR component hierarchy under the node:
BC Basis -
Middleware
The BAPIs BapiService.DataConversionExt2Int and BapiService.DataConversionInt2Ext have been set to 'obsolete'. From now on you should use the new BAPIs BapiService.DataConversionExt2Int1 and BapiService.DataConversionInt2Ext1 or change your existing developments to the new BAPIs.
The BAPI Programming Guide in the R/3 Library contains detailed information about enhancing BAPIs released by SAP.
  • Central Note on BAPIs with 'Commit Work'
From Release 4.0 BAPIs are normally implemented without an integrated 'Commit Work' command. This allows several BAPIs to be combined in one Logical Unit of Work (LUW). All BAPIs with 'Commit Work' are listed in the Online Software Service (OSS) in the central note 0131838 "Collective Note for BAPIs with "Commit Work' Command".
  • New BAPIs
Many new BAPIs have been implemented in Release 4.6A. Details of the new BAPIs listed below are provided in the BAPI Explorer in the R/3 System. (Up-to-date information on BAPIs implemented in 4.6A is available from the Open BAPI Network.)
In area Basis / Cross-Application Components:
Business Object BapiService
(Standard service functions for BAPIs)
DataConversionExt2Int1
(Converts data from external to internal format)
DataConversionInt2Ext1
((Converts data from internal to external format
HyperLinkGetText
(Reads documentation hypertext link)
Business Object MonitorTreeElement
(Defines a monitor tree element)
DisableAlertGeneration
(Switches off alert generation for a monitor tree element)
EnableAlertGeneration
(Switches on alert generation for a monitor tree element)
GetAlerts
(Reads the alerts for a monitor tree element)
GetGeneralProperties
(Reads the properties of a monitor tree element)


GetMessageLogCurrentValue
(Reads the current values of a log attribute)
GetMessageLogHistory
(Reads the value history of a log attribute)
GetMessageLogProperties
(Reads the properties of a log attribute)

GetPerformanceAttrCurrentValue
(Reads the currrent performance values)
GetPerformanceAttrHistory
(Reads the history of the performance data)
GetPerformanceAttrProperties
(Reads the performance attributes of specified property)
GetStatusMessageAttrProperties
(Reads the properties of a status attribute)

GetStatusMessageAttrValue
(Reads the current value of a status attribute)
GetTree
(Reads the sub-tree expanded by monitor tree element)

Reset
(Resets properties of the monitor tree element)
SplitData
(Splits the data in a tree node into "logical"
units)
Business Object SystemAlert
(Defines a system alert)
Acknowledge
(Acknowledges an alert)
GetDetails
(Reads the details of an alert)
SplitData
(Splits alert data into "logical" units)
Business Object SystemMonitor
(Defines a monitor)
GetDetails
(Reads the (display) properties of a system monitor)
GetList
(Reads all monitors in a monitor set)
GetTemplate
(Reads system monitor template)
GetTree
(Reads the monitor tree associated with the monitor)
Business Object SystemMonitorSet
(Defines a monitor set)
GetDetails
(Reads the (display) properties of a monitor set)
GetList
(Reads all stored monitor sets)
Business Object SystemMonitorTree
(Defines a monitor tree)
CreateByTemplate
(Creates a monitor tree using a monitor template)
GetAlertData
(Reads alert data of a monitor tree)
In area Human Resources:
Business Object EmployeeBankDetailJP
(Employee bank details Japan)
Getdetail
(Reads employee bank details)
Getdetailedlist
()
Business Object EmployeeFamilyJP
(Employee family/related person Japan)
Create
()
Createsuccessor
()
Getdetail
()
Getdetailedlist
()
Request
()
Simulatecreation
()
Business Object EmployeePersDataJP
(Employee data for person)
Change
()
Create
()
Createsuccessor
()
Getdetail
()
Getdetailedlist
()
Simulatecreation
()
Business Object EmployeePrivatAdrCH
(Employee address Switzerland)
Change
(Changes employee address)
Create
(Creates employee address)
Createsuccessor
(Creates employee address subsequent record)
Getdetail
(Reads employee address)
Getdetailedlist
(Reads instances with data)
Request
(Creates locked employee address)
Simulatecreation
(Simulates creation of employee address)
Business Object EmployeePrivateAdrJP
(Employee address Japan)
Change
(Changes employee address)
Create
(Creates employee address)
Createsuccessor
(Creates employee address subsequent record)
Getdetail
(Reads employee address)
Getdetailedlist
(Reads instances with data)
Request
(Creates locked employee address)
Simulatecreation
(Simulates creation of employee address)
EmployeePrivateAdrNL
(Employee address Netherlands)
Change
(Changes employee address)
Create
(Creates employee address)
Createsuccessor
(Creates employee address subsequent record)
Getdetail
(Reads employee address)
Getdetailedlist
(Reads instances with data)
Request
(Creates locked employee address)
Simulatecreation
(Simulates creation of employee address)
In Logistics area:
Business Object ItCustBillingDoc
(Customer individual billing document)
Cancel
(Cancels customer individual billing document)
Confirm
(Confirms object)
CreateMultiple
(Creates customer individual billing document)
ExistenceCheck
(Checks existence of object)
GetDetail
(Detailinformationen zur einer Faktura)
GetList
(Reads detailed information on a billing document)
In Accounting area:





RFUMSV00 - Advance Return for Tax on Sales/Purchases   rdisp/max_wprun_time - Maximum work process run time  
This documentation is copyright by SAP AG.

Length: 11067 Date: 20191017 Time: 153852     sap01-206 ( 33 ms )

Our Service

Looking for Support? Questions?

The

Consolut

Callback-Service

Leave us your contact details and we will call you back. Panels marked with * are mandatory.