The Oracle BAM web services are part of the Oracle BAM technologies that feeds data to the Oracle BAM Server. This chapter provides information about using the Oracle BAM web services.
The Oracle BAM web services allow users to build applications that publish data to the Oracle BAM Server for use in real-time charts and dashboards. Any client that can talk to standard web services can use these APIs to publish data to Oracle BAM. The Oracle BAM web services interfaces allow integration of Oracle BAM with other components such as Oracle BPEL Process Manager and Oracle Mediator, and they facilitate SOA composite application development.
The data objects in the Oracle BAM Server are available using the Oracle BAM web services.
Using the DataObjectOperations Web Services
The DataObjectOperations web service allows users to manipulate the Data Objects in the Oracle BAM Server by inserting, updating, deleting and upserting rows into the Data Objects.
- Batch performs batch operations on a data object. Batch is not supported for DataObjectOperationsByName web service.
- Delete removes a row from the data object.
- Get fetches the details from a data object per the specifications in the XML payload. Get is only available in DataObjectOperationsByName web service.
- Insert adds a row to the data object.
- Upsert inserts new data into an existing row in a data object if the row exists. If the row does not exist a new row is created.
- Update inserts new data into an existing row in a data object.
How Use the DataObjectOperations web service
To use the DataObjectOperations web service, create a web service proxy in your application in Oracle JDeveloper.
- Start JDeveloper id it’s not running.
- Create New Application. Create ADF Application name it as BAMwebservice
- The Web Services Description Language (WSDL) files for the DataObjectOperations web services are available at the following URLs on the system where Oracle BAM web services are installed.
- Create the web service proxy in application.
- Right click on Model project of BAMwebservice
- From New Gallery from Categories select Web Services and from Items select web service Proxy and click OK.
- Create Web Service Proxy wizard will be open click Next.
- Select JAX-WS Style from select client style and click Next.
- Past WSDL Document URL and lick Next.
- Click next from specify default mapping options.
- Click next from End points.
- Select Generate asynchronous methods where specified by JAX-WS binding and click Next.
- Click Next from Policy.
- Click Next from Defined Handlers.
- Click Finish to complete Create Web Service Proxy Wizard.
- Once you web service proxy is created, you see it in the Application Navigator under the Application Sources folder in your project
Using the DataObjectDefinition Web Service
The DataObjectDefinition web service allows a web service client to create, update, delete, and get data object definitions.
The following operations are supported by DataObjectDefinition web service.
- Create creates a data object.
- Delete removes a data object from the server.
- Get returns the definition of an existing data object.
- Update changes the definition of a data object
The request and response messages vary depending on the operation used.
How to Use the DataObjectDefinition Web Service
- To use the DataObjectDefinition web service you create a web service proxy in your application in Oracle JDeveloper.
- The WSDL file for the DataObjectDefinition web service is available at the following URL on the system where Oracle BAM web services are installed.
- When the web service proxy is created, you see it in the Application Navigator under the Application Sources folder in your project
Using the ManualRuleFire Web Service
The ManualRuleFire web service allows users to launch rules in the Oracle BAM Server. FireRuleByName is the available operation.
How to Use the ManualRuleFire Web Service
- To use the ManualRuleFire web service, you create a web service proxy in your application in Oracle JDeveloper.
- The WSDL file for the ManualRuleFire web service is available at the following URL on the system where Oracle BAM web services are installed.
- When the web service proxy is created, you see it in the Application Navigator under the Application Sources folder in your project.
Using the ICommand Web Service
ICommand is available as a web service for application developers who want to interact with ICommand features over HTTP.
The ICommand web service includes most of the same features as the command-line utility. For example, you can use it to:
- Delete a data object
- Import rows into a data object
- Export a report
The key differences revolve around the fact that the web service cannot access files on the remote system. Therefore, you cannot pass in a file name when using the import command or the export command.
Instead, you must pass in the import content inline. Similarly, you receive the export content inline.
Commands other than import and export generally work the same as with the command-line utility.
How to Use the ICommand Web Service
The WSDL file for the ICommand web service is available on the system where Report Server has been installed. It is available at the following URL: