Show full documentation

 Show full documentation

Definition

An interface to query Product Business Partner Relation.

Business Context and Use

The web service interface QueryProductBusinessPartnerRelationIn enables you to connect external applications to your SAP system and to query and read data of BO Product Business Partner Relation within your system. The web service interface is relevant if your company wants to access and manage Product Business Partner Relation data from external applications.

The web service interface QueryProductBusinessPartnerRelationIn offers the operation FindByElements.

Constraints and Integrity Conditions

General Rules for Using this Web Service

Communication Timeout

Query operations are mass-enabled stateless synchronous web service operations. Transferring or requesting amounts of data that are too large can cause communication timeouts. The web service consumer (external application) is responsible for ensuring reasonable sizes for mass operations.

Processing Conditions

The query processing conditions specify how to process a query with respect to the maximum number of hits to be returned.

Query request messages provide the following processing parameters:

• Query hits maximum number value (element name QueryHitsMaximumNumberValue): Maximum number of hits to be returned by an inquiry.

• Query hits unlimited indicator (element name QueryHitsUnlimitedIndicator): Indicates whether the maximum number of hits to be returned by an inquiry is unlimited or not.

• Last returned object ID (element name LastReturnedObjectID): Identifies the last object returned by a previous inquiry.

Note: If QueryHitsUnlimitedIndicator = true, QueryHitsMaximumNumberValue must not be filled.

Query response messages provide the following elements:

• Returned query hits number value (element name ReturnedQueryHitsNumberValue): The number of hits returned by an inquiry.

• More hits available indicator (element name MoreHitsAvailableIndicator): Indicates whether there are more than ReturnedQueryHitsNumberValue hits matching the selection criteria or not.

• Last returned object ID (element name LastReturnedObjectID): Identifies the last object returned by this inquiry.

Note: Processing conditions can be used for the paging of query results. However, it is crucial not to change the query selection parameters from request to request. Otherwise, the query result might change.

Selection Parameter

Query selection parameters are mainly exposed as select options or ranges with an inclusion/exclusion code, interval boundary type code, lower boundary value, and upper boundary value.

The inclusion/exclusion code (element name InclusionExclusionCode) specifies the inclusion or exclusion of a set into a result set.

Inclusion Exclusion Code	Description
E	Excluding
I	Including

The interval boundary type code (element name IntervalBoundaryTypeCode) is used to describe intervals by their boundaries. Depending on the operator, the lower boundary value or both boundary values are relevant.

Interval Boundary Type Code	Name	Description
1	Equal to	Single value	= X
2	Between (excluding upper boundary)	Interval with closed lower and open upper boundary	[X, Y)
3	Between	Interval with open lower and open upper boundary	(X, Y)
4	Between (excluding both boundaries)	Interval with open lower and open upper boundary	(X, Y)
5	Between (excluding lower boundary)	Interval with open lower and closed upper boundary	(X, Y]
6	Less than	Interval with unlimited lower and open upper boundary	< X
7	Less Than or Equal to	Interval with unlimited lower and closed upper boundary	<= X
8	Greater Than	Interval with open lower and unlimited upper boundary	> X
9	Greater Than or Equal to	Interval with closed lower and unlimited upper boundary	= X

Response Message

The structure of the query response message consists of three parts:

• A business document-specific part containing the returned business documents

• Processing conditions

• Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request.

More Information

General Information

You can find general information about Web services, their structure and consumption in the Web Services documentation.

Scenarios

Possible scenarios include the following:

• Select Product Business Partner Relation by

  • Identifier

  • BusinessPartnerInternalID

  • LifeCycleStatusCode

  • TypeCode

  • ValidityFromDate

  • ValidityToDate

Example to select Product Business Partner Relation by Identifier (with prefix PRODUCT_LIST_ ):

<n0:ProductBusinessPartnerRelationByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <ProductBusinessPartnerRelationSelectionByElements>
  <SelectionByIdentifier>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryIdentifier>PRODUCT_LIST_*</LowerBoundaryIdentifier>
  </SelectionByIdentifier>
 </ProductBusinessPartnerRelationSelectionByElements>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
 </ProcessingConditions>
</n0:ProductBusinessPartnerRelationByElementsQuery_sync>

Example to select Product Business Partner Relation by Business Partner(Account: P1000):

<n0:ProductBusinessPartnerRelationByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <ProductBusinessPartnerRelationSelectionByElements>
  <SelectionByBusinessPartnerInternalID>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
   <LowerBoundaryBusinessPartnerInternalID>P1000</LowerBoundaryBusinessPartnerInternalID>
  </SelectionByBusinessPartnerInternalID>
 </ProductBusinessPartnerRelationSelectionByElements>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>100</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
 </ProcessingConditions>
</n0:ProductBusinessPartnerRelationByElementsQuery_sync>

 Show full documentation

 Show full documentation

Definition

FindByElements is an operation to select Product Business Partner Relation data.

Business Context and Use

The request message of the operation FindByElements contains the QueryByElements that groups all possible selection parameters.

Structure

Request

Find By Elements

Selection Parameter	Remark
SelectionByIdentifier	Selection by ID
SelectionByBusinessPartnerInternalID	Selection by business partner internal ID of a business partner
SelectionByLifeCycleStatusCode	Selection by lifecycle status
SelectionByTypeCode	Selection by type code
SelectionByValidFromDate	Selection by valid from date
SelectionByValidToDate	Selection by valid to date

Response

The response contains the selected product business partner relation data, log items, and processing conditions.