This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Skip to end of metadata
  • Created by Former user, last modified by Former user on Feb 05, 2017
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Overview

The following operations allow you to work with outbound deliveries. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to carry out operations on outbound deliveries, see Sample configuration. 

OperationDescription
queryOutboundDeliverables

Retrieves outbound deliveries by elements.

readOutboundDeliverablesReads details of an outbound delivery.

Operation details

This section provides further details on each of the operations.

Retrieving outbound deliveries by elements

The queryOutboundDeliverables operation retrieves outbound deliveries by elements.

queryOutboundDeliverables 
<sapbydesign.queryOutboundDeliverables>
    <queryObject>{$ctx:queryObject}</queryObject>
    <processingConditionsObject>{$ctx:processingConditionsObject}</processingConditionsObject>
</sapbydesign.queryOutboundDeliverables>
Properties
  • queryObject:Contains the request message that has various selection parameters to query and read the information regarding outbound delivery. 
  • processingConditionsObject:The xml object that specifies the conditions to process the query result.
Sample request

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

Sample Request for queryOutboundDeliverables 
<queryOutboundDeliverables>
    <username>USERNAME</username>
    <password>PASSWORD</password>
    <sapHost>HOST</sapHost>
    <blocking>false</blocking>
    <queryObject>
        <OutboundDeliveryFindByElementsRequestMessageBody/>
    </queryObject>
    <processingConditionsObject>
        <ProcessingConditions>
            <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator>
        </ProcessingConditions>
    </processingConditionsObject>
</queryOutboundDeliverables>
Related SAP Business ByDesign documentation

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

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

Reading outbound deliveries

The readOutboundDeliverables operation reads all the information related to an outbound delivery.

readOutboundDeliverables
<sapbydesign.readOutboundDeliverables>
    <outboundDeliveryObject>{$ctx:outboundDeliveryObject}</outboundDeliveryObject>
</sapbydesign.readOutboundDeliverables>
Properties
  • outboundDeliveryObject: Contains the UUIDs of all the outbound deliveries to be read.
Sample request

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

Sample Request for readOutboundDeliverables
<readOutboundDeliverables>
    <username>USERNAME</username>
    <password>PASSWORD</password>
    <sapHost>HOST</sapHost>
    <blocking>false</blocking>
    <outboundDeliveryObject>
        <OutboundDelivery>
            <UUID>00163E02-8660-1EE2-8FF0-0CB8250DC543</UUID>
        </OutboundDelivery>
    </outboundDeliveryObject>
</readOutboundDeliverables>
Related SAP Business ByDesign documentation

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

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

Sample configuration

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

Sample Proxy
<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="sapbydesign_queryOutboundDeliverables"
       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/*"/>
         <sapbydesign.init>
             <username>{$ctx:username}</username>
             <password>{$ctx:password}</password>
             <sapHost>{$ctx:sapHost}</sapHost>
             <blocking>{$ctx:blocking}</blocking>
         </sapbydesign.init>
         <sapbydesign.queryOutboundDeliverables>
             <queryObject>{$ctx:queryObject}</queryObject>
             <processingConditionsObject>{$ctx:processingConditionsObject}</processingConditionsObject>
         </sapbydesign.queryOutboundDeliverables>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>
  • No labels