| Description | Query Object Identifier Mappings |
| Name | CommunicationServicesManagementQueryObjectIdentifierMappingIn |
| Namespace | http://sap.com/xi/CommunicationServicesManagement/Global |
| Process Component Description | Communication Services Management |
| Process Component Name | CommunicationServicesManagement |
| Process Component Namespace | http://sap.com/xi/CommunicationServicesManagement/Global |
| Deployment Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
The inbound query service OIM is a web service interface used for queries of object-identifier mappings between objects in an SAP remote business system and a local SAP On-Demand system.
The web service interface Query Object Identifier Mapping In enables you to connect external applications to your SAP On-Demand system and to submit queries of object-identifier mappings between object identifiers in a remote business system, such as an SAP ERP or a SAP CRM suite system, and object identifiers in the SAP On-Demand system.
The Query Object Identifier Mapping In web service interface offers a Find Object Identifier Mapping By Elements operation.
The web service interface uses a remote object ID with its remote ID type and a local object ID with its local ID type. Remote objects are objects located in a business system. Local objects are objects located in an SAP On-Demand system.
A web service handles an application-specific business document. Business documents used in the following descriptions are object-identifier mappings in this document when dealing with the Query Object Identifier Mapping In web service.
Query operations are mass-enabled stateless synchronous web service operations. Transferring or requesting amounts of data that are too large causes communication timeouts. The web service consumer (external application) is responsible for ensuring reasonable sizes for mass operations.
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, as otherwise the query result might change.
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 |
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.
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
| Description | Find object identifier mappings |
| Name | FindObjectIdentifierMappingByElements |
| Synchronous | yes |
| Release Status | Released |
To find object identifier mappings by elements.
The request message of the operation FindObjectIdentifierMappingByElements contains the ObjectIdentifierMappingByElements node that groups all possible selection parameters.
When you create a query request message for object-identifier mappings, you must provide both remote ID types and local ID types to specify object types in the corresponding systems.
The IF_AP_ID_DEFINING_SCHEME_COD_C code list for object-identifier mappings contains all ID types as interface constants that can be used for specifying types of objects located in the On-Demand system or in the remote business systems that are connected to that On-Demand system.
For the object-identifier mappings between an SAP ERP Suite system and a local On-Demand system, SAP recommends that you use following remote and local ID types:
| Object Name | Remote ID type | Local ID type |
|---|---|---|
| Acccount | 918 | 888 |
| Contact | 927 | 930 |
| Material | 20 | 938 |
| Product Category | 923 | 770 |
| Sales Organization | 917 | 227 |
For the object-identifier mappings between an SAP CRM suite system and a local On-Demand system, SAP recommends that you use following remote and local ID types:
| Object Name | Remote ID type | Local ID type |
|---|---|---|
| Business Partner | 888 | 888 |
| Material | 935 | 938 |
| Product Category | 936 | 770 |
| CRM Organization & Unit | 227 | 227 |
Ensure that you use the object ID instead of the Universally Unique Identifier (UUID) object for both remote and local object IDs in a request message for querying object-identifier mappings.
You need to provide information about the remote business system, in which remote objects involved in the object-identifier mappings are located, in a request message for querying object-identifier mappings.
A remote business system can be established with one of the following identifiers used in a request message: ID, Intermediate Document Logical System ID, Business System ID, or UUID. When one (or more) identifiers of a remote business system is given, a query shall be run to find the remote business system and the result of that query is the UUID of the remote business system, which shall be used for querying the corresponding object-identifier mappings.
The ID-Mapping-specific part of a response message lists the local object type codes and the local object node type codes that belong to the local business objects in the local On-Demand system along with the remote and local IDs and their identifier types.
Object type codes and object node type codes are used in SAP On-Demand systems to identifier business objects. You can find the relationships between object ID types used for object-identifier mappings and their corresponding object type codes and object node type codes in the APC_I_IDSC system table.
Object-identifier mappings for product categories can be found by using local ID type 770 and local object IDs of product categories in On-Demand systems as described in section Remote and Local Object ID Types.
There is one limitation of using this operation for finding object-identifier mappings of product categories. There should exist only one product category hierarchy in the On-Demand system, so that local object IDs of product categories used in a request message of the operation are unique in the On-Demand system.
If there are more than one product category hierarchy in your On-Demand system, other alternatives for finding Object ID mappings should be used such as using the user interface for object-identifier mappings or the corresponding Object ID Mapping API of the On-Demand system.
Show full documentation
Show full documentation