Description | Manage Object Descriptions |
Name | ManageObjectDescriptionIn |
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 read the description of objects.
The web service interface Manage Object Description In enables you to connect external applications to your on-demand system and to read descriptions of various objects in your system. It is relevant to retrieve the descriptions of your master data by ID or UUID.
The web service interface Manage Object Description In offers the operation Read. Paging is not supported for this operation.
Description | Read object descriptions |
Name | Read |
Synchronous | yes |
Release Status | Released |
To read object descriptions.
This operation reads descriptions of objects for given object IDs or UUIDs. 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.
The following object types are currently supported. The parameters are described in more detail in the structure section below.
ES BO Name | Object Type Code | Object Node Type Code | Language Dependency | Context | |
---|---|---|---|---|---|
Business Partner | 147 | - | No | - | |
Chart of Accounts Item | 890 | - | Yes | Chart of Accounts | Selection by UUID not supported |
Company | 154 | - | Yes | - | |
Product Category | 221 | - | Yes | Product Category Hierarchy | |
Product | 988 | - | No | Product Identifier Type Code, Product Type Code | Selection by UUID not supported |
Product Requirement Secification | 357 | - | No | - | |
Profit Centre | 229 | - | Yes | - | |
Project | 231 | - | Yes | - | |
Project Task | 231 | 1020 | Yes | - | |
Segment | 256 | - | Yes | - | |
Set of Books | 436 | - | Yes | - | Selection by UUID not supported |
Further implementations can be provided on request.
The request contains the following parameters:
Object Type Code
Object Node Type Code
Object ID
Object UUID
Language Code
Object Context ID
The mandatory request parameter Object Type Code specifies the object type of the objects to get descriptions of. Note that you can only specify a single Object Type Code in a request.
Either one or more Object IDs or one or more Object UUIDs have to be specified to restrict the selection of objects read. Note that for some object types a selection by UUID is not supported.
Optionally, additional parameters can or have to be provided:
An Object Node Type Code has to 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 languange dependent.
An Object Context ID has to be specified for object types with an object ID that is unique within a certain context. In the context ID the object IDs of the objects that build the context are concatenated separated by a single space.
Example (showing a request for object type Project Task):
<n0:ObjectDescriptionByIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ObjectDescription> <ObjectTypeCode>231</ObjectTypeCode> <ObjectNodeTypeCode>1020</ObjectNodeTypeCode> <ObjectID>AXUS_1</ObjectID> <ObjectID>AXUS_1-8</ObjectID> <ObjectID>MC-1239-6</ObjectID> <LanguageCode>EN</LanguageCode> </ObjectDescription> </n0:ObjectDescriptionByIDQuery_sync>
Further examples are given below.
The operation returns a list of objects IDs with their descriptions, according to the parameters specified in the request. If an Object Context ID had been specified in the request this context ID is also returned.
Example (showing a response for object Project Task):
<n0:ObjectDescriptionByIDResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QCL:/1SAI/TASFE8AEBAA9D55A13E0B7E:804"> <ObjectDescription> <ObjectID>AXUS_1</ObjectID> <Description languageCode="EN">Approximal Analyser Implementation</Description> </ObjectDescription> <ObjectDescription> <ObjectID>AXUS_1-8</ObjectID> <Description languageCode="EN">Blueprint Review</Description> </ObjectDescription> <ObjectDescription> <ObjectID>MC-1239-6</ObjectID> <Description languageCode="EN">Event Execution</Description> </ObjectDescription> </n0:ObjectDescriptionByIDResponse_sync>
Example request for object type Business Partner
<n0:ObjectDescriptionByIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ObjectDescription> <ObjectTypeCode>147</ObjectTypeCode> <ObjectID>1000190</ObjectID> </ObjectDescription> </n0:ObjectDescriptionByIDQuery_sync>
Example request for object type Company
<n0:ObjectDescriptionByIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ObjectDescription> <ObjectTypeCode>154</ObjectTypeCode> <ObjectID>BSRPM100</ObjectID> <ObjectID>GCFR10000</ObjectID> <LanguageCode>EN</LanguageCode> </ObjectDescription> </n0:ObjectDescriptionByIDQuery_sync>
Example request for object type Product
<n0:ObjectDescriptionByIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ObjectDescription> <ObjectTypeCode>988</ObjectTypeCode> <ObjectContextID>1 1</ObjectContextID> <ObjectID>1</ObjectID> <ObjectID>10000000</ObjectID> </ObjectDescription> </n0:ObjectDescriptionByIDQuery_sync>
Example request for object type Product Category (with object UUIDs specified in the request)
<n0:ObjectDescriptionByIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <ObjectDescription> <ObjectTypeCode>221</ObjectTypeCode> <ObjectNodeTypeCode>2623</ObjectNodeTypeCode> <LanguageCode>EN</LanguageCode> <ObjectUUID>00300571-C924-02EC-88DA-E6D49863C6A6</ObjectUUID> <ObjectUUID>00300571-C924-02EC-88DA-E6DE3EC046AE</ObjectUUID> </ObjectDescription> </n0:ObjectDescriptionByIDQuery_sync>