Versions Compared

Old Version 7

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel3
typeflat

Overview

The following operations allow you to work with methods for Materials in SAP ByDesign system. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with Materials through the ESB connector, see Sample configuration. 

OperationDescription
Working with Materials in SAP Business ByDesignRetrieves query material data by elements.

Operation details

This section provides further details on the operations related to Materials in SAP ByDesign system.

Related SAP ByDesign documentation

You can browse the Docs available in your SAP ByDesign system or else find this documentation:

http://help.sap.com/saphelp_byd1405/en/PUBLISHING/PSM_ISI_R_II_QUERY_MAT_IN.html

...

The queryMaterials operation is to query the materials in your The queryMaterials operation retrieves material information from your SAP Business ByDesign system.

Code Block
languagexml
titlequeryMaterials
<sapbydesign.queryMaterials>
    <queryObject>{$ctx:queryObject}</queryObject>
    <processingConditionsObject>{$ctx:processingConditionsObject}</processingConditionsObject>
    <requestedElementsObject>{$ctx:requestedElementsObject}</requestedElementsObject>
</sapbydesign.queryMaterials>
Properties
  • queryObject               : Query object that groups : Contains all possible MaterialSelectionByElements section query parameters grouped within the MaterialSelectionByElements node.
  • processingConditionsObject: The xml object which that contains the conditions to manage the query result.
  • requestedElementsObject   : The xml object which that determines the material data elements to be retrieved.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the queryMaterials operation.

Code Block
languagexml
titleSample Request for queryMaterials Method 
<queryMaterials>
    <username>USERNAME</username>
    <password>PASSWORD</password>
    <sapHost>HOST</sapHost>
    <blocking>false</blocking>
    <queryObject>
        <MaterialSelectionByElements>
            <SelectionByInternalID>
                <InclusionExclusionCode>I</InclusionExclusionCode>
                <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode>
                <LowerBoundaryInternalID>RC-70-00037-01</LowerBoundaryInternalID>
                <UpperBoundaryInternalID/>
            </SelectionByInternalID>
        </MaterialSelectionByElements>
    </queryObject>
    <processingConditionsObject>
        <ProcessingConditions>
            <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator>
            <LastReturnedObjectID></LastReturnedObjectID>
        </ProcessingConditions>
    </processingConditionsObject>
    <requestedElementsObject>
        <RequestedElements materialTransmissionRequestCode="2">
            <Material descriptionTransmissionRequestCode="2" quantityConversionTransmissionRequestCode="2"
                      salesTransmissionRequestCode="1"/>
        </RequestedElements>
    </requestedElementsObject>
</queryMaterials>
Related SAP Business ByDesign documentation

http://help.sap.com/saphelp_byd1405/en/PUBLISHING/PSM_ISI_R_II_QUERY_MAT_IN.html

You can also browse the related documentation available in your SAP Business ByDesign system.

Anchor
sampleconfiguration
sampleconfiguration
Sample configuration

Following is a sample proxy service that illustrates how to connect to SAP Business ByDesign with the init operation and use the queryMaterials operation. The sample request for this proxy can be found in the queryMaterials sample request. You can use this sample as a template for using other operations in this category.

Code Block
languagexml
titleSample Proxy
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="sapbydesign_queryMaterials"
       transports="https,http"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
   <target>
      <inSequence onError="faultHandlerSeq">
         <property name="username" expression="//username"/>
         <property name="password" expression="//password"/>
         <property name="sapHost" expression="//sapHost"/>
         <property name="blocking" expression="//blocking"/>
         <property name="queryObject" expression="//queryObject/*"/>
         <property name="processingConditionsObject" expression="//processingConditionsObject/*"/>
         <property name="requestedElementsObject" expression="//requestedElementsObject/*"/>
         <sapbydesign.init>
             <username>{$ctx:username}</username>
             <password>{$ctx:password}</password>
             <sapHost>{$ctx:sapHost}</sapHost>
             <blocking>{$ctx:blocking}</blocking>
         </sapbydesign.init>
         <sapbydesign.queryMaterials>
             <queryObject>{$ctx:queryObject}</queryObject>
             <processingConditionsObject>{$ctx:processingConditionsObject}</processingConditionsObject>
             <requestedElementsObject>{$ctx:requestedElementsObject}</requestedElementsObject>
         </sapbydesign.queryMaterials>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>