| Description | Query Object Descriptions |
| Name | QueryObjectDescriptionIn |
| Namespace | http://sap.com/xi/Common/DataTypes |
| Process Component Description | Metadata Repository Management |
| Process Component Name | MetadataRepositoryManagement |
| Process Component Namespace | http://sap.com/xi/Metamodel |
| Deployment Unit Description | Basis |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to query the description of objects.
The web service interface Query Object Description In enables you to connect external applications to your on-demand system and to query descriptions of various objects in your system. It is relevant to assemble the descriptions of your master data.
The web service interface Query Object Description In offers the operation Find Obj Descr By Elements. This operation supports paging for most objects, exceptions are mentioned in the operation description.
| Description | Find object descriptions |
| Name | FindObjectDescriptionByElements |
| Synchronous | yes |
| Release Status | Released |
To find object descriptions by elements.
This operation queries descriptions of objects. With each call of the operation descriptions of objects of exactly one type are determined. The type is specified in the mandatory request parameter Object Type Code.
Paging is supported, exceptions are documented in the section on prerequisites.
The following object types are supported by this operation. The parameters are described below in structure section.
| ES BO Name | Object Type Code | Object Node Type Code | Language dependency | Key date / validity period | Last Changed Date Time | Context | |
|---|---|---|---|---|---|---|---|
| Business Partner | 147 | - | No | Yes | Yes | - | |
| Chart of Accounts Item | 890 | - | Yes | No | No | Chart of Accounts | No Paging supported |
| Company | 154 | - | Yes | Yes | No | - | |
| Fixed Asset | 176 | - | No | Yes | No | Company ID, Master Fixed Asset ID | |
| Product Category | 221 | - | Yes | No | No | Product Category Hierarchy | |
| Product | 988 | - | No | No | No | Product Identifier Type Code, Product Type Code | |
| Product Requirement Specification | 357 | - | Yes | No | Yes | - | |
| Profit Centre | 229 | - | Yes | Yes | No | - | |
| Project | 231 | - | Yes | No | Yes | - | |
| Project Task | 231 | 1020 | Yes | No | No | - | |
| Segment | 256 | - | Yes | Yes | No | - | |
| Set of Books | 436 | - | Yes | No | No | - | |
| Set of Books Accounting Period | 436 | 5320 | Yes | No | No | Set of Books, Company Assignment, Company Assignment Fiscal Year |
Descriptions of the following objects can be determined as described:
| ES BO Name | Comments |
|---|---|
| Affiliated Company | Query object type Company as described above. |
| Employee | Use a separate service Query Employee In II_QUERY_EMPLOYEE_IN. |
| Individual Material | Queryobject type Product as described above. |
Further implementations can be provided on request.
The request contains the following parameter:
Object Type Code
Object Node Type Code
Language Code
Validity Start / End Date
Last Changed Date Time
The mandatory request parameter Object Type Code specifies the object type to get descriptions of.
Optionally, additional parameters can or have to be provided:
An Object Node Type Code should be specified if the object is not sufficiently described by the object type, as it is represented by a subnode of the corresponding business object.
A Language Code has to be specified if the description of the object type is language dependend. An error message will occur if this parameter is specified even though the description of object type is not language dependend.
A Validity Start and/or Validity End Date can be specified to restrict the selection of objects queried. If any of the dates are provided, the descriptions of only those objects are returned for which the validity period or key date lies within or overlaps with the provided validity period. An error message will occur if this parameter is specified even though the object type has no key date or validity period.
A last changed date time can be specified to restrict the selection of objects queried to those for which the last change date time is equal to or higher than the specified one. An error message will occur if this parameter is specified even though not supported for the object type.
Example (showing a request for object type Business Partner):
Show full documentation
Show full documentation<n0:ObjectDescriptionByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<ObjectDescriptionSelectionByElements>
<SelectionByObjectTypeCode>147</SelectionByObjectTypeCode>
<SelectionByLastChangeDateTime>2013-03-28T12:00:00.1234567Z</SelectionByLastChangeDateTime>
<SelectionByValidityStartDate>1999-01-24</SelectionByValidityStartDate>
<SelectionByValidityEndDate>2999-01-24</SelectionByValidityEndDate>
</ObjectDescriptionSelectionByElements>
<ProcessingConditions>
<QueryHitsMaximumNumberValue>3</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
</ProcessingConditions>
</n0:ObjectDescriptionByElementsQuery_sync>
Further examples are given below.
The operation returns a list of objects IDs with their descriptions, according to the query parameters specified in the request. If the ID of the object is unique only within a certain context, the Context ID is also returned. In the context ID the object IDs of the objetcs that build the context are concatenated separated by a single space.
Example (showing a response for object type Business Partner):
<n0:ObjectDescriptionByElementsResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TASF0978E004EA90B1DE038:804">
<ObjectDescription>
<ObjectID>1000410</ObjectID>
<Description>TestABCUpdate</Description>
</ObjectDescription>
<ObjectDescription>
<ObjectID>1000420</ObjectID>
<Description>Customer</Description>
</ObjectDescription>
<ObjectDescription>
<ObjectID>8000000160</ObjectID>
<Description>Hans Schmitt</Description>
</ObjectDescription>
<ObjectDescription>
<ObjectID>8000000161</ObjectID>
<Description>Hans Schmitt</Description>
</ObjectDescription>
<ObjectDescription>
<ObjectID>PUNYCTR02</ObjectID>
<Description>FirstLineNameTestOrg-PUNYCTR02 SecondLineNameTestOrg-PUNYCTR02</Description>
</ObjectDescription>
<ProcessingConditions>
<ReturnedQueryHitsNumberValue>5</ReturnedQueryHitsNumberValue>
<MoreHitsAvailableIndicator>true</MoreHitsAvailableIndicator>
<LastReturnedObjectID>00163E04F8F91ED383E2F776FD569AF3</LastReturnedObjectID>
</ProcessingConditions>
</n0:ObjectDescriptionByElementsResponse_sync>
Example request for object type Product
<n0:ObjectDescriptionByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<ObjectDescriptionSelectionByElements>
<SelectionByObjectTypeCode>988</SelectionByObjectTypeCode>
</ObjectDescriptionSelectionByElements>
<ProcessingConditions>
<QueryHitsMaximumNumberValue>20</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
</ProcessingConditions>
</n0:ObjectDescriptionByElementsQuery_sync>
Example request for object type Product Category
<n0:ObjectDescriptionByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<ObjectDescriptionSelectionByElements>
<SelectionByObjectTypeCode>221</SelectionByObjectTypeCode>
<SelectionByLanguageCode>EN</SelectionByLanguageCode>
</ObjectDescriptionSelectionByElements>
<ProcessingConditions>
<QueryHitsMaximumNumberValue>5</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
</ProcessingConditions>
</n0:ObjectDescriptionByElementsQuery_sync>
Example request for object type Product Requirement Specification
<n0:ObjectDescriptionByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<ObjectDescriptionSelectionByElements>
<SelectionByObjectTypeCode>357</SelectionByObjectTypeCode>
<SelectionByLanguageCode>EN</SelectionByLanguageCode>
<SelectionByLastChangeDateTime>2013-03-28T12:00:00.1234567Z </SelectionByLastChangeDateTime>
</ObjectDescriptionSelectionByElements>
<ProcessingConditions>
<QueryHitsMaximumNumberValue>3</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
</ProcessingConditions>
</n0:ObjectDescriptionByElementsQuery_sync>
Example request for object type Segment
<n0:ObjectDescriptionByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<ObjectDescriptionSelectionByElements>
<SelectionByObjectTypeCode>256</SelectionByObjectTypeCode>
<SelectionByValidityStartDate>1999-01-24</SelectionByValidityStartDate>
<SelectionByValidityEndDate>2999-01-24</SelectionByValidityEndDate>
<SelectionByLanguageCode>EN</SelectionByLanguageCode>
</ObjectDescriptionSelectionByElements>
<ProcessingConditions>
<QueryHitsMaximumNumberValue>3</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
</ProcessingConditions>
</n0:ObjectDescriptionByElementsQuery_sync>
Example request for object type Project Task
<n0:ObjectDescriptionByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<ObjectDescriptionSelectionByElements>
<SelectionByObjectTypeCode>231</SelectionByObjectTypeCode>
<SelectionByObjectNodeTypeCode>1020</SelectionByObjectNodeTypeCode>
<SelectionByLanguageCode>EN</SelectionByLanguageCode>
</ObjectDescriptionSelectionByElements>
<ProcessingConditions>
<QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
</ProcessingConditions>
</n0:ObjectDescriptionByElementsQuery_sync>