Show TOC

Find Business Partner Relationship Basic Data by ElementsLocate this document in the navigation structure

Definition

An operation that finds a list of business partner relationships based on specified search criteria.

Technical Data

Entity Type

Service Operation

Release State

Released

Technical Name

BusinessPartnerDataManagementQueryBusinessPartnerRelationshipIn.FindBusinessPartnerRelationshipBasicDataByElements

Mode

Synchronous

Idempotency

Not applicable

Change/Update Behavior

Not applicable
Business Context

For more information about the business context, see the Business Partner Relationship business object.

Related Operations

Business-Related Operations

Not applicable

Compensation Operation

Not applicable

Counterpart Operation

Not applicable

Features

To search for business partner relationships, you have the following options:

  • Selection by relationship key date (BusinessPartnerRelationshipKeyDate element)

  • Selection by partner number (SelectionByBusinessPartnerInternalID element)

  • Selection by identification number (SelectionByBusinessPartnerIdentification element)

  • Selection by GUID (SelctionByBusinessPartnerUUID element)

  • Selection by relationship category (SelectionByBusinessPartnerRelationshipRoleCode element)

Note that when used as search criteria, the LowerBoundaryBusinessPartnerInternalIDSearchText and LowerBoundaryBusinessPartnerIDSearchText elements support the following searches:

  • A wildcard search (using the character * to represent 0..n characters)

  • A case-insensitive search

The response lists all the relationships of business partners that match the specified search criteria. Each relationship includes the following information:

  • The details of the business partner relationship (CategoryCode and CategoryName elements)

  • The details of the first and second business partner (UUID, InternalID, CategoryCode and CategoryName elements)

  • The names and identifications of the business partners (Name and Identification elements under the Common node)

  • The validity period of the relationship (ValidityPeriod element)

Note that the results are restricted by the authorization of the caller. If a caller is not authorized to view a particular relationship, the system does not return any relationships and does not display any error messages.

Processing Conditions

The response message returns the number of hits in the ReturnedQueryHitsNumberValue element.

The number of hits in the search results can either be restricted to a maximum (QueryHitsMaximumNumberValue element) or have an unlimited number of hits (QueryHitsUnlimitedIndicator element)

For searches where the number of hits exceeds the maximum number of hits specified (QueryHitsMaximumNumberValue element), the MoreHitsAvailableIndicator indicator is set in the response of the operation. In this case, the following additional search criteria can be specified:

  • Category code (LastReturnedBusinessPartnerRelationshipCategoryCode element)

  • Internal ID of the first business partner (LastReturnedBusinessPartnerRelationshipFirstBusinessPartnerInternalID element)

  • Internal ID of the second business partner (LastReturnedBusinessPartnerRelationshipSecondBusinessPartnerInternalID element) of the last returned entry in the response to continue the search from the last entry found by the first service response.

Error Handling

For more information, see Error Handling in Financial Services .

The following main error messages are recorded in the log of the response message:

  • DCE.VME (Value Mapping Error):

    • FSBP_MAIN_ERROR_MSG 013 (Error occurred during mapping (inbound))

    • FSBP_MAIN_ERROR_MSG 014 (Error occurred during mapping (outbound))

  • FOE.SVE (Scheme Violation Error): FSBP_MAIN_ERROR_MSG 011 (Error during validation (inbound))

For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode.

Message Types

  • BusinessPartnerRelationshipFSBasicDatabyElementsQuery

  • BusinessPartnerRelationshipFSBasicDatabyElementsResponse

Notes on SAP Implementation

Authorization

The user must be authorized to find business partner relationships. The following authorization objects are checked in the SAP back-end system:

  • B_BUPA_GRP

  • B_BUPA_RLT

  • B_BUPR_BZT

Enhancements

You can find the Business Add-In (BAdI) BAdI for FindBusinessPartnerRelationshipBasicDataByElements(FSBPR_FND_SE_FIND) for this operation through Transaction SIMGH. Choose Start of the navigation path BAdIs for XI Interfaces Next navigation step Mapping and Processing of Service Enhancements Next navigation step Business Partner Relationship End of the navigation path. Depending on the application, the BAdIs for XI Interfaces structure could also be available in the IMG of your system such as SAP Policy Management.