Show full documentation

 Show full documentation

Definition

An interface to query organisational units.

Business Context and Use

The web service interface QueryOrganisationalUnitIn enables you to connect external applications to your SAP system and to query and read organisational units within your system. The web service interface is relevant if your company wants to access and manage organisational unit data from external applications.

The web service interface QueryOrganisationalUnitIn 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

Requested Elements

Requested elements (element name RequestedElements) enable web service consumer to specify which elements are to be selected so that response messages contain only data which are required. This reduces also the size of query response messages and thus transmission and response times.

Requested elements contain transmission request codes for controlling the transmission of corresponding query response node elements.

The transmission request codes are modeled as xml attributes following the syntax: <element name>TransmissionRequestCode.

The prefix <element name> is equivalent to the name of the node element in the response message to which the transmission request code applies.

Transmission Request Code	Name	Description
1	Complete Structure	The node element and all its elements, its child node elements and all their elements will be returned.
2	Complete Node	The node element and all its elements will be returned.
3	Node with Key Elements	The node element and its key elements will be returned (not supported by all web service interfaces).
4	Excluded Node	The node element and its child node elements will not be returned.

The transmission request code is optional. If no transmission request code is modeled or provided by the service consumer, then the following rules apply:

1. If no transmission request code is provided at all, then the response message contains all data.

2. If the transmission request code of the parent node element is 1, then its sub-node elements for which no transmission request code is specified are defaulted by 1.

3. If the transmission request code of the parent node element is 2 or 3, then its sub-node elements for which no transmission request code is specified are defaulted by 4.

4. If the transmission request code of the parent node element is 4, then its sub-node elements are not returned anyway.

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 organisational units by

  • Identifier

  • Name

  • BuyerIdentifier

  • BuyerPartyBusinessPartnerInternalID

  • LifeCycleStatusCode

  • PostingDateTime

  • DataOriginTypeCode

  • ApprovalStatusCode

  • EmployeeResponsibleBusinessPartnerInternalID

  • SalesUnitID

  • SalesOrganisationID

  • DistributionChannelCode

  • ProductID

  • LastChangeDateTime

Example to select the first 10 customer quotes with a validity between 1.1.1999 and 31.12.2005:

<n0:OrganisationalUnitByIDQuery_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <OrganisationalUnitSelectionByID>
  <ValidityPeriodStartDate>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>9</IntervalBoundaryTypeCode>
   <LowerBoundaryDate>1999-01-01</LowerBoundaryDate>
  </ValidityPeriodStartDate>
  <ValidityPeriodEndDate>
   <InclusionExclusionCode>I</InclusionExclusionCode>
   <IntervalBoundaryTypeCode>7</IntervalBoundaryTypeCode>
   <LowerBoundaryDate>2005-12-31</LowerBoundaryDate>
  </ValidityPeriodEndDate>
 </OrganisationalUnitSelectionByID>
 <ProcessingConditions>
  <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue>
  <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
 </ProcessingConditions>
</n0:OrganisationalUnitByIDQuery_Sync>

 Show full documentation

 Show full documentation

No documentation available.