Oracle® Retail Integration Bus Service-Oriented Architecture Enabler Tool Guide Release 16.0.027 E97048-01 |
|
Previous |
Next |
The sample below can be used as an initial template.
<serviceProviderDefLibrary appName="rms" xmlns="http://www.oracle.com/retail/integration/services/serviceProviderDefLibrary/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <service name="Supplier"><!-- Noun, don't put suffix Service --> <documentation /> <operation name="create"><!-- Verb --> <documentation>Create a new SupplierDesc.</documentation> <input type="SupplierDesc"><!-- Existing BO --> <documentation> Input SupplierDesc to create. </documentation> </input> <output type="SupplierRef"> <documentation> Return the SupplierRef for the newly created SupplierDesc. </documentation> </output> <fault faultType="IllegalArgumentWSFaultException">
<documentation> Throw this exception when it is "soap:Client" side message problem. </documentation> </fault> <fault faultType="EntityAlreadyExistsWSFaultException"> <documentation> Throw this exception when the object already exist. </documentation> </fault> <fault faultType="IllegalStateWSFaultException"> <documentation> Throw this exception when there is unknown "soap:Server" side problem. </documentation> </fault> </operation> <operation name="createSupSiteUsing"><!-- Verb --> <documentation>Create a new SupplierSite.</documentation> <input type="SupplierDesc"><!-- Existing BO --> <documentation> Input SupplierDesc to create. </documentation> </input> <output type="SupplierRef"> <documentation> Return the SupplierRef for the newly created SupplierDesc. </documentation> </output> <fault faultType="IllegalArgumentWSFaultException"> <documentation> Throw this exception when it is "soap:Client" side message problem. </documentation> </fault> <fault faultType="EntityAlreadyExistsWSFaultException"> <documentation> Throw this exception when the object already exist. </documentation> </fault> <fault faultType="IllegalStateWSFaultException"> <documentation> Throw this exception when there is unknown "soap:Server" side problem. </documentation>
</fault> </operation> <operation name="createSupSiteAddrUsing"><!-- Verb --> <documentation>Create a new SupplierSite.</documentation> <input type="SupplierDesc"><!-- Existing BO --> <documentation> Input SupplierDesc to create. </documentation> </input> <output type="SupplierRef"> <documentation> Return the SupplierRef for the newly created SupplierDesc. </documentation> </output> <fault faultType="IllegalArgumentWSFaultException"> <documentation> Throw this exception when it is "soap:Client" side message problem. </documentation> </fault> <fault faultType="EntityAlreadyExistsWSFaultException"> <documentation> Throw this exception when the object already exist. </documentation> </fault> <fault faultType="IllegalStateWSFaultException"> <documentation> Throw this exception when there is unknown "soap:Server" side problem. </documentation> </fault> </operation> <operation name="update"> <input type="SupplierDesc" /> <output type="SupplierDesc" /> <fault faultType="IllegalArgumentWSFaultException" /> <fault faultType="EntityNotFoundWSFaultException" /> <fault faultType="IllegalStateWSFaultException" /> </operation> <operation name="updateSupSiteUsing"> <input type="SupplierDesc" /> <output type="SupplierDesc" /> <fault faultType="IllegalArgumentWSFaultException" /> <fault
faultType="EntityNotFoundWSFaultException" /> <fault faultType="IllegalStateWSFaultException" /> </operation> <operation name="updateSupSiteOrgUnitUsing"> <input type="SupplierDesc" /> <output type="SupplierDesc" /> <fault faultType="IllegalArgumentWSFaultException" /> <fault faultType="EntityNotFoundWSFaultException" /> <fault faultType="IllegalStateWSFaultException" /> </operation> <operation name="updateSupSiteAddrUsing"> <input type="SupplierDesc" /> <output type="SupplierDesc" /> <fault faultType="IllegalArgumentWSFaultException" /> <fault faultType="EntityNotFoundWSFaultException" /> <fault faultType="IllegalStateWSFaultException" /> </operation> <operation name="find" suffix="outputType"> <input type="SupplierRef" /> <output type="SupplierDesc" /> <fault faultType="IllegalArgumentWSFaultException" /> <fault faultType="EntityNotFoundWSFaultException" /> <fault faultType="IllegalStateWSFaultException" /> </operation> <operation name="delete"> <input type="SupplierRef" />
<output type="SupplierRef" /> <fault faultType="IllegalArgumentWSFaultException" /> <fault faultType="EntityNotFoundWSFaultException" /> <fault faultType="IllegalStateWSFaultException" /> </operation> <operation name="create"> <input type="SupplierCollectionDesc" /> <output type="SupplierCollectionRef" /> <fault faultType="IllegalArgumentWSFaultException" /> <fault faultType="EntityAlreadyExistsWSFaultException" /> <fault faultType="IllegalStateWSFaultException" /> </operation> <operation name="update"> <input type="SupplierCollectionDesc" /> <output type="SupplierCollectionDesc" /> <fault faultType="IllegalArgumentWSFaultException" /> <fault faultType="EntityNotFoundWSFaultException" /> <fault faultType="IllegalStateWSFaultException" /> </operation> <operation name="find" suffix="outputType"> <input type="SupplierCollectionRef" /> <output type="SupplierCollectionDesc" /> <fault faultType="IllegalArgumentWSFaultException" /> <fault faultType="EntityNotFoundWSFaultException" /> <fault faultType="IllegalStateWSFaultException" /> </operation> <operation name="delete"> <input type="SupplierCollectionRef" /> <output type="SupplierCollectionRef" /> <fault faultType="IllegalArgumentWSFaultException" /> <fault faultType="EntityNotFoundWSFaultException" /> <fault faultType="IllegalStateWSFaultException" /> </operation> </service> </serviceProviderDefLibrary>
Following is a sample service definition xml for REST services:
<serviceProviderDefLibrary appName="rms" xmlns="http://www.oracle.com/retail/integration/services/serviceProviderDefLibrary/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <service name="Suppliers"> <operation name="find" operationType="READ_WITH_IDENTITY" suffix="outputType"> <input type="Nothing" identifierNameList="sup_xref_key,supplier_id"/> <output type="SupplierDesc"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> <operation name="create" operationType="CREATE"> <input type="SupplierDesc" identifierNameList="sup_xref_key,supplier_id"/> <output type="SupplierRef"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> <operation name="update" operationType="UPDATE"> <input type="SupplierDesc" identifierNameList="sup_xref_key,supplier_id"/> <output type="Nothing"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> <operation name="delete" operationType="DELETE"> <input type="SupplierDesc" identifierNameList="sup_xref_key,supplier_id"/> <output type="Nothing"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> <operation name="searchAll" operationType="READ_WITH_PREDICATE" suffix="outputType"> <input type="Nothing" queryParamList="country_id"/> <output type="SupplierColDesc"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> <operation name="createAll" operationType="CREATE"> <input type="SupplierColDesc"/> <output type="SupplierColRef"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> <operation name="updateAll" operationType="UPDATE"> <input type="SupplierColDesc"/> <output type="Nothing"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> <operation name="deleteAll" operationType="DELETE"> <input type="SupplierColDesc" queryParamList="country_id"/> <output type="Nothing"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> </service> <service name="PayTerm"> <operation name="find" operationType="READ_WITH_IDENTITY" suffix="outputType"> <input type="PayTermRef" identifierNameList="terms_xref_key,terms"/> <output type="PayTermDesc"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> <operation name="calculateTotal" operationType="PROCESS"> <input type="PayTermDesc" /> <output type="PayTermRef"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> </service> <service name="CustOrdItm"> <operation name="find" operationType="READ_WITH_IDENTITY" suffix="outputType"> <input type="ReferenceId" identifierNameList="id"/> <output type="CustOrdItmPkVo"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> <operation name="create" operationType="CREATE"> <input type="CustOrdItmPkVo"/> <output type="ReferenceId"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> <operation name="taxLines" operationType="NAVIGATE_TO_CHILD"> <input type="Nothing" queryParamList="tax_id"/> <output type="TaxLinePkColVo"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> </service> <service name="Customers"> <operation name="searchAll" operationType="READ_WITH_PREDICATE" suf-fix="outputType"> <input type="Nothing" queryParamList="customer_type"/> <output type="CustomerColDesc"> </output> <fault faultType="IllegalArgumentWSFaultException" /> </operation> </service> </serviceProviderDefLibrary>