Show TOC

Function documentationStandardized BAPIs Locate this document in the navigation structure

 

Some BAPIs and methods provide basic functions and can be used for most SAP business object types. Such parameters are known as "standardized" BAPIs.

Features

With object methods and especially with BAPIs, you can differentiate between instance methods and class methods. Instance methods refer to precisely one instance (one specific occurrence) of an SAP Business Object type, for example, to one explicitly specified customer order. Whereas class methods are instance-independent.

BAPIs for Reading Data

The following BAPIs provide you with read-only access to data in the associated business object type:

  • GetList ( )

    With the BAPI GetList() you can select a range of object key values, for example, company codes and material numbers. The BAPI GetList( ) is a class method.

  • GetDetail ( )

    The BAPI GetDetail() uses a key to retrieve details about an instance (one specific occurrence) of a business object type and returns this data to the calling program. Then this information is reported back to the calling program. The BAPI GetDetail() is an instance method.

  • GetStatus()

    The BAPI GetStatus() is used to query the status of an SAP business object instance, for example, the processing status of a sales order. This BAPI is used only for displaying the status of an object and does not retrieve full details like the BAPI GetDetail(). The BAPI GetStatus( ) is an instance method.

  • ExistenceCheck()

    The BAPI ExistenceCheck() checks whether an entry exists for a business object instance, for example, whether the customer master has been created. The ExistenceCheck() BAPI is an instance method.

BAPIs for Creating or Changing Data

The following BAPIs can create, change or delete instances of a business object type:

  • Create ( ) or CreateFromData ( )

    The BAPIs Create() and CreateFromData() create an instance of an SAP business object type, such as a purchase order. These BAPIs are class methods.

    For more information see Programming Create() BAPIs.

  • Change ( )

    The BAPI Change() changes an existing instance of an SAP business object, for example, a sales order. The BAPI Change ( ) is an instance method.

    For more information see Programming Change() BAPIs.

  • Delete ( ) and Undelete ( )

    The BAPI Delete( ) deletes an instance of an SAP business object from the database or sets a deletion flag.

    The BAPI Undelete( ) removes a deletion flag.

    These BAPIs are instance methods.

    For more information see Programming Delete()/Undelete() BAPIs.

  • Cancel ( )

    Unlike the BAPI Delete( ), the BAPI Cancel( ) cancels an instance of a business object, that is the instance to be cancelled remains in the database and an additional instance is created which is actually canceled.

    The Cancel( ) BAPI is an instance method.

    For more information, see Programming Cancel() BAPIs.

  • Add<subobject> ( ) and Remove<subobject> ( )

    The BAPI Add<Subobject>() adds a sub-object to an existing object instance and the BAPI Remov<Subobject>() removes a sub-object from an object instance. These BAPIs are instance methods.

    For more information, see Programming Methods for Subobjects.

Note Note

If you are implementing BAPIs that create or change data you should consider using buffering. For further information, see Buffering for Write BAPIs.

End of the note.
BAPIs for Mass Processing

The BAPIs listed in the above section, "BAPIs for Creating or Changing Data", can also be used for mass processing. Here, when a BAPI is called, several business object instances are processed at the same time.

With BAPIs for mass processing, the suffix "Multiple" is added to the method name, for example, ChangeMultiple(), CreateMultiple(), DeleteMultiple(). The BAPIs here are always class methods.

Note Note

We strongly recommend that you create instance-dependent BAPIs with buffering. For further information, see Buffering for Write BAPIs.

End of the note.
BAPIs for Replicating Business Object Instances

The following BAPIs are used for replicating business object instances:

  • Replicate ( ) and SaveReplica ( )

    The BAPIs Replicate() and SaveReplica() are implemented as methods of replicable business object types. They enable specific instances of an object type to be copied to one or more different systems. These BAPIs are used mainly to transfer data between distributed systems within the context of Application Link Enabling (ALE). These BAPIs are class methods.

    For more information, see Programming Replicate()/SaveReplica() BAPIs.