| Description | Manage Kit Item List |
| Name | ManageKitItemListIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Product Data Maintenance |
| Process Component Name | ProductDataMaintenance |
| Process Component Namespace | http://sap.com/xi/AP/FO/Product/Global |
| Deployment Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to migrate or create Kit Item List from a source system or file.
The web service Interface 'Manage Kit Item List In' enables you to connect external applications to your SAP Business ByDesign system and to create and edit Kit Item List in your system. The web service interface 'Manage Kit Item List In' is relevant if your company wants to access and manage Kit Item List data from external applications.
The web service interface Manage Kit Item List In offers the operations MAINTAIN_BUNDLE.
Here is an example of a simple web service request:
Show full documentation
Show full documentation
<n0:KitItemListBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<KitItemList>
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<ChangeStateID></ChangeStateID>
<ActionCode>01</ActionCode>
<ComponentsListCompleteTransmissionIndicator>true</ComponentsListCompleteTransmissionIndicator>
<OutputMaterialKey>
<ProductTypeCode>1</ProductTypeCode>
<ProductIdentifierTypeCode>1</ProductIdentifierTypeCode>
<ProductID>MCF-KIT-0004</ProductID>
</OutputMaterialKey>
<OutputMaterialQuantity unitCode="ea">1</OutputMaterialQuantity>
<OutputMaterialQuantityTypeCode>ea</OutputMaterialQuantityTypeCode>
<Description>
<ActionCode>01</ActionCode>
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<Description languageCode="EN">FND Test</Description>
</Description>
<Components>
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<ActionCode>01</ActionCode>
<InputProductKey>
<ProductTypeCode>1</ProductTypeCode>
<ProductIdentifierTypeCode>1</ProductIdentifierTypeCode>
<ProductID>MCF-0001</ProductID>
</InputProductKey>
<InputProductQuantity unitCode="ea">2</InputProductQuantity>
<InputProductQuantityTypeCode>ea</InputProductQuantityTypeCode>
<DistributionPercentage>49</DistributionPercentage>
</Components>
<Components>
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<ActionCode>01</ActionCode>
<InputProductKey>
<ProductTypeCode>1</ProductTypeCode>
<ProductIdentifierTypeCode>1</ProductIdentifierTypeCode>
<ProductID>MCF-0002</ProductID>
</InputProductKey>
<InputProductQuantity unitCode="ea">3</InputProductQuantity>
<InputProductQuantityTypeCode>ea</InputProductQuantityTypeCode>
<DistributionPercentage>51</DistributionPercentage>
</Components>
</KitItemList>
</n0:KitItemListBundleMaintainRequest_sync>
Action codes represent an instruction to the recipient of the web service request to process transmitted message node elements.Following are the existing action codes and their description.
| Action Code | Description |
|---|---|
| 01 | Create; the system returns an error message if the node element already exists. |
| 02 | Update; the system returns an error message if the node element does not exist. |
| 03 | Delete; the system returns an error message if the node element does not exist. |
| 04 | Save; the system creates or changes the node element data. |
| 05 | Remove; the system deletes the node element. If the node element does not exist, the system does not send an error message. |
| 06 | No Action; the system does not change the node element. |
Default action code: 04 (Save).
Note: Action code 04 (Save) creates business documents if the system could not identify a matching target business document. This applies in particular if no business document ID or UUID is provided by the web service consumer. The web service consumer (external application) is responsible for providing correct business document IDs or UUIDs and to avoid accidental creation of duplicate business documents.
The processing of node elements with cardinality > 1 (for example a list of descriptions in different languages or a list of telephone numbers) can be controlled using List Complete Transmission Indicators (LCTI). The LCTI indicates whether a list of node elements is transmitted completely. The LCTI of a node element with cardinality > 1 is modeled as an attribute of its parent node element (attribute name: <name of child element>ListCompleteTransmissionIndicator).
| LCTI | Description |
|---|---|
| False | The list of node elements is not transmitted completely and hence all node elements that are not transmitted remain unchanged. If transmitted node elements in the list can be identified uniquely, the system processes the node elements according to the action code. If transmitted node elements in the list cannot be identified uniquely, the system appends the node element to the corresponding list of node elements in the target business document. |
| true | The list of elements is transmitted completely and hence all node elements that are not transmitted are removed. If no node element is transmitted, the complete list is removed. |
Default list complete transmission indicator: false.
Note: The LCTI refers to the completeness of the list of node elements and does not state completeness of sub-elements.
New description with language code DE (German) is created while an existing description with language code EN (English) is updated. Moreover, an existing description with language code FR (French) remains unchanged and any other description, with language code ES (Spanish) for example, is deleted. An error is raised if there is already a German description or if the English or French description does not exist.
<Root actionCode="04" descriptionListCompleteTransmissionIndicator="true" >
<Description actionCode="01">
<Description languageCode="DE">neuer deutscher Text
</Description>
<Description actionCode="02">
<Description languageCode="EN">changed english text
</Description>
<Description actionCode="06">
<Description languageCode="FR"></Description>
</Description>
</Root>
Optional leaf elements in request messages that are not transmitted within a web service request are not changed in corresponding business documents.
In updating a postal address of a Purchase Order , the request updates the city name, street postal code, street name, and house ID. The country code remains unchanged, as the element "CountryCode" is not contained in the XML document (commented out).
<PostalAddress actionCode="02"> <!-- <CountryCode>DE</CountryCode> --> <CityName>Heidelberg</CityName> <StreetPostalCode>69117</StreetPostalCode> <StreetName>Hauptstrasse</StreetName> <HouseID></HouseID> </PostalAddress>
Note: The request deletes the house ID or updates the house ID with its initial value.
Maintain bundle and check maintain bundle 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 is responsible for ensuring reasonable sizes of data for mass operations.
Maintain bundle and check maintain bundle operations support exactly one execution (idem potency). To ensure exactly one execution of web service requests, the web service consumer has to provide unique values for the elements ID or UUID of the BasicMessageHeader node element.
Using change state identifier (element name ChangeStateID), external applications can enforce that a modifying operation is not executed because the state of the business document has changed since the external application last read its data.
The change state ID is an un-interpretable string that is provided by query and read operations and can be utilized by all modifying operations. If the change state identifier is provided when calling a modifying operation, the system does not perform the operation if the state of the business document instance has changed since the change state ID was computed. If the change state ID is not provided by the web service consumer, the system performs the web service operation without checking the state of the business document.
The web service consumer (external application) is responsible for preventing accidental changes to business documents.
Request node elements with cardinality > 1 contain an object node sender technical identifier to relate response message elements and log items to corresponding node elements in the request message.
The object node sender technical identifiers are provided as ObjectNodeSenderTechnicalID in request message types and referred to as ReferenceObjectNodeSenderTechnicalID in corresponding response message types.
If the object node sender technical ID is initial, the object node sender technical ID of the parent node element in the request is returned as the reference object node sender technical ID. If the object node sender technical IDs of all parent node elements are initial, the reference object node sender technical ID is returned as initial as well.
Note: The values specified in the ObjectNodeSenderTechnicalID are transient values that establish the correspondence between elements for only a single call. The web service consumer is not required to specify them or to use the same values for different calls. In addition, the service provider does not interpret these values at all, but returns them to the web service consumer instead in the ReferenceObjectNodeSenderTechnicalID elements.
Note: The ObjectNodeSenderTechnicalID is also used to identify failed business document modifications in a mass operation.
Request
<Child> <ObjectNodeSenderTechnicalID>999_A<ObjectNodeSenderTechnicalID> <Content>Child A: Some correct content</Content> </Child> <Child> <ObjectNodeSenderTechnicalID>999_B<ObjectNodeSenderTechnicalID> <Content>Child B: Some erroneous content</Content> </Child>
Response:
<Log> <Item> <ReferenceObjectNodeSenderTechnicalID>999_B </ReferenceObjectNodeSenderTechnicalID> <Note>Error message for Child B</Note> </Item> </Log>
The structure of the response message consists of two parts:
• A business document-specific part containing information about IDs and UUIDs of the created and changed business documents
• Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request
Many external applications consuming web services have special requirements and restrictions regarding the format of WSDLs. Some external applications require service definition WSDLs describing the web service signature. This is normally sufficient for the creation of static client-side proxies. Other external applications, normally those that do not create static client-side proxies, require binding WSDLs including the endpoint definition and authentication policy information.
In both cases, it may be the case that the external application imposes special restrictions on the structure or the size of WSDLs.
Microsoft InfoPath requires binding WSDLs and considers elements with the attribute "minOccurs=0" as "mandatory". However "minOccurs=0" means "optional" in SAP web services. In order to circumvent this problem, the WSDL must be saved locally and an additional attribute "nillable=true" must be added to make a query parameter optional for Microsoft InfoPath.
For very small clients such as mobile devices, the size of the WSDL itself may become a problem. In most cases the client only requires a very small part of the signature, but due to the complexity of the WSDL they may end up with long runtimes during serialization of the request or deserialization of the response. In order to circumvent this problem, the WSDL must be saved locally and the optional parts of the signature have to be removed before the WSDL is imported or static client-side proxies are generated.
External applications have to take into account that web service request and response message types can be enhanced with additional elements and attributes. Enhancements can be created by SAP, SAP partners, and key users. Enhancements of request message types are always optional elements or attributes. The SAP system does not require the external application to provide values in the request. Enhancements of response message types can contain mandatory elements or attributes. The external application must be able to process the extended response successfully.
XML element and attribute names are always stable. Technical definitions of data types can be enhanced in a compatible way. This may result in changed data type names. External applications can rely on XML element names and attribute names, but should not rely on data type names.
Note: You can download the WSDL file for any web service here:
• Application and User Management work center -> Input Output Management -> Communication Arrangement.
• User Management work center -> Service Explorer view.
You can find the documentation of the global data types in the SAP Community Network: Go to http://scn.sap.com/docs/DOC-17516 and click View Document.
| Description | Maintain kit item list |
| Name | MaintainBundleManageKitItemList |
| Synchronous | yes |
| Release Status | Released |
To create, update, or delete Kit Item List in Business ByDesign system.
The request message of the operation MaintainBundle contains a Basic Message Header node element as well as a Kit Item List node element that contains the Kit Item List data to be created or updated. The detailed structure of the Kit Item List node will be explained in the following sub-chapters. The Kit Item List node can occur multiple times in the request message – this means that multiple kit item list can be created through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a Kit Item List specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as Kit ID and UUID.
An interface to create and update kit item list base on existing sales kit.
Structure of the request message has the following nodes and elements
The Kit Item List node elements contain all general information such as ID, quantity, and quantity type code. The data of this node is related to the General Data on the Kit UI.
OutputMaterialKey : The Kit ID with which the Kit can be addressed and found.
OutputMaterialQuantity : The quantity of the Kit.
OutputMaterialQuantityTypeCode : The unit if the quantity.
Description : The description of the Kit.
Components : The components of the Kit.
Kit ID and UUID
Change State ID and Sender Technical ID
Log: Containing the error messages from the processing of the request.
| Description | Check manage kit item list |
| Name | CheckMaintainBundleManageKitItemList |
| Synchronous | yes |
| Release Status | Released |
To simulate the MAINTAIN_BUNDLE service interface operation of kit item list.
The request message of the operation Maintain Bundle contains a BasicMessageHeader node element as well as a kit item list node element that contains the kit item list data to be created. The detailed structure of the kit item list node will be explained in the following sub-chapters. The shopping cart node can occur multiple times in the request message – this means that multiple kit item list can be created through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a Kit Item List-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as Kit Item List ID and UUID.
An interface to create and update kit item list base on existing sales kit.
Structure of the request message has the following nodes and elements
The Kit Item List node elements contain all general information such as ID, quantity, and quantity type code. The data of this node is related to the General Data on the Kit UI.
OutputMaterialKey : The Kit ID with which the Kit can be addressed and found.
OutputMaterialQuantity : The quantity of the Kit.
OutputMaterialQuantityTypeCode : The unit if the quantity.
Description : The description of the Kit.
Components : The components of the Kit.
Kit ID and UUID
Change State ID and Sender Technical ID
Log: Containing the error messages from the processing of the request.