Working with Material in SAP Business ByDesign

The queryMaterials operation retrieves material from your SAP Business ByDesign system.

queryMaterials

<sapbydesign.queryMaterials>
    <queryObject>{$ctx:queryObject}</queryObject>
    <processingConditionsObject>{$ctx:processingConditionsObject}</processingConditionsObject>
    <requestedElementsObject>{$ctx:requestedElementsObject}</requestedElementsObject>
</sapbydesign.queryMaterials>

Properties

queryObject: Groups all possible query parameters within the MaterialSelectionByElements node.
processingConditionsObject: The xml object that contains the conditions to manage the query result.
requestedElementsObject: The xml object that determines the material data elements to be retrieved.

Sample request

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

Sample Request for queryMaterials

<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>

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 queryMaterials sample request.

Sample 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>

Working with Material in SAP Business ByDesign

Properties

Sample request

Related SAP Business ByDesign documentation

Sample configuration