Cloud Documentation
Advanced Search


Getting Started with Web Services
Close Window

Table of Contents

Show All | Collapse

1 Introduction to Using Web Services

This section describes web services and introduces common tasks for integrating with or extending Oracle Fusion Applications in Oracle Applications Cloud Services.

Topics:

About Web Services

A web service is a program that can be accessed remotely using different standards-based languages. What this program can do (that is, the functionality it implements) is described in a standard vocabulary.

Major benefits of web services include:

  • Interoperability among distributed applications that span diverse hardware and software platforms

  • Easy, widespread access to applications through firewalls using web protocols

  • A cross-platform, cross-language data model (XML) that facilitates developing heterogeneous distributed applications

Web services are characterized by three factors:

  • What they do (the business functionality they expose)

  • Where they are (the web site which exposes that functionality)

  • How they can be accessed (the set of published interfaces necessary to use the exposed functionality)

Web services rely on XML-based and other industry standards:

  • Extensible Markup Language (XML): A data format that allows uniform communication between web services consumers and web services providers.

  • XML Schema: A framework that describes XML vocabularies used in business transactions.

  • Simple Object Access Protocol (SOAP): A protocol for exchanging structured information in the implementation of web services.

  • Web Services Description Language (WSDL): An XML-based language providing a model for describing SOAP-based web services.

  • WS-Policy: The WS-Policy framework provides a flexible and extensible grammar for describing the capabilities, requirements, and general characteristics of web services using policies.

In summary, web services are loosely coupled, distributed environments that allow companies to integrate heterogeneous applications within the enterprise or expose business functions to their customers and partners over the Internet. Because you access web services using standard web protocols such as XML and HTTP, the diverse and heterogeneous applications on the web (which typically already understand XML and HTTP) can automatically access web services and communicate with each other.

About Oracle Fusion Applications Web Services

Oracle Fusion Applications provides web services as one of many mechanisms to integrate with and extend Oracle Fusion Applications in Oracle Applications Cloud Services. The web services are typically based on a business objects and allow the caller to perform operations on the business objects. As an example, the Opportunity Service can be used to perform a find operation to identify opportunities meeting a search criteria or to perform an update to a field, like a quantity on a particular revenue item, on an opportunity.

This document provides general information about web services in Oracle Fusion Applications in Oracle Applications Cloud Services. Oracle Fusion Applications in Oracle Applications Cloud Services includes:

  • Human Capital Management Cloud: Oracle Global Human Resources Cloud

  • Enterprise Resource Planning Cloud

  • Customer Experience Cloud: Oracle Sales Cloud

  • Supply Chain Management Cloud

Finding Your Tasks Quickly

The following topics provide guidance on using web services.

Topics:

General Tasks for Web Services

What do you want to do? How to do it...

Browse all web services in Oracle Fusion Applications.

Look up all web services in the Oracle Enterprise Repository (OER) by following the instructions in Searching for Public External Services.

Note that all web services listed in the OER may not be provisioned in your cloud instance. To browse services on your cloud instance, see Using the Service Catalog Service.

Identify all web services provisioned on my cloud instance.

Follow Using the Service Catalog Service.

Learn about a particular web service.

I would like to know what operations which are defined on the service and the shape of the request and response payloads.

Look up a web service in the Oracle Enterprise Repository (OER) by following the instructions in Searching for Public External Services.

Learn about using the create, get, update, merge, delete, find and process (CRUD) operations. I would like to see example payloads for the CRUD operations.

The CRUD operations are typically defined on the business object services. See About Operations.

Get the service end point URL for a particular web service deployed to my cloud instance.

Find the end point URL using one of two options:

Option 1:

See Using the Service Catalog Service.

Option 2:

  1. Look up the web service in the Oracle Enterprise Repository to get the service path by following the instructions in Searching for Public External Services.

  2. Derive the end point by following the instructions in Deriving the Business Object Service Endpoint and WSDL.

Learn about services with a Deprecated life cycle value.

The service which I am invoking as part of my integration is marked as Deprecated. What does Deprecated mean?

See About Life Cycle.

Learn about the kinds of service interface changes which may be introduced as part of an upgrade.

I am planning an integration using web services. I want to know the kinds of changes to the service interface which I can expect when my cloud instance is upgraded to a new Oracle Fusion Applications release.

See About Backward Compatibility.


Use Case Based Scenarios for Web Services

What do you want to do? How to do it...

Implement one of the documented use cases in the Use Cases for Implementing Partner Applications for Oracle Sales Cloud guide:

The use case exactly matches my use case requirements.

  1. Follow the instructions for one of the documented use case in Use Web Services in Use Cases for Implementing Partner Applications for Oracle Sales Cloud.

  2. Look up the end point for the web services in the use case using one of two options:

    Option 1:

    See Using the Service Catalog Service.

    Option 2:

    a. Look up the web service in the Oracle Enterprise Repository to get the service path by following the instructions in Searching for Public External Services.

    b. Derive the end point by following the instructions in Deriving the Business Object Service Endpoint and WSDL.

Implement one of the documented use cases in the Use Cases for Implementing Partner Applications for Oracle Sales Cloud guide. However, my requirements are not completely met by the documented use case. I want to learn more about the other operations available for the services described in the use case and other elements available in the payloads.

  1. Follow the instructions for one of the documented use case in Use Web Services n Use Cases for Implementing Partner Applications for Oracle Sales Cloud.

  2. Follow the instructions in Searching for Public External Services to look up a web service in the Oracle Enterprise Repository (OER).

  3. Look up the end point for the web services in the use case using one of two options:

    Option 1:

    See Using the Service Catalog Service.

    Option 2:

    a. Look up the web service in the Oracle Enterprise Repository to get the service path by following the instructions in Searching for Public External Services.

    b. Derive the end point by following the instructions in Deriving the Business Object Service Endpoint and WSDL.

Implement a use case that is not documented in the Use Cases for Implementing Partner Applications for Oracle Sales Cloud guide, or implement a use case that is for an Oracle Cloud service other than Oracle Sales Cloud.

I first want to discover the web services that are defined for a particular business object in my use case.

Look up a web service in the Oracle Enterprise Repository (OER) by following the instructions in Searching for Public External Services. Use the name or logical business object as the search criteria.