Print      Open PDF Version of Online Help


Previous Topic

Next Topic

Downloading WSDL and Schema Files

The Web services provided by Oracle CRM On Demand allow users of client applications to interact with Oracle CRM On Demand, for example, to insert, update, delete, and query records and to perform a number of administrative tasks.

The Web services are available through:

  • Web Services v1.0. Used to interact with Custom Objects 01-03, as well as preconfigured objects.
  • Web Services v2.0. Used to interact with all Oracle CRM On Demand custom objects, as well as preconfigured objects. Compared to Web Services version 1.0, the Web Services version 2.0 API also offers additional options for issuing queries, using the QueryPage method.
  • Service APIs. Used to manage administrative tasks through Web services. For example, service APIs allow the administration of users in Oracle CRM On Demand, and provide the ability to issue queries for system and usage information in relation to Oracle CRM On Demand.
  • Administrative Services. Used to interact with Oracle CRM On Demand metadata through Web services. Administrative Services provides the capability of reading and loading Oracle CRM On Demand metadata in an XML format.

From the Web Services Administration page you can:

  • Download the Web Services Description Language (WSDL) files used by applications that access the Web services
  • Download schema files
  • Access the Web services documentation

Downloading WSDL Files

You can download WSDL files for each record type, and for each of the service APIs.

To download a WSDL file

  1. In the upper-right corner of any page, click the Admin global link.
  2. In the Web Service Integration section, click Web Services Administration.
  3. From the Select Service list, select Web Services v1.0, Web Services v2.0, Service APIs, or Administrative Services as required.
  4. From the WSDL Object list, select the required record type, for example, Account, or the name of the service API.

    The objects displayed in the WSDL Object list depend on the record types that are set up for your company.

  5. Click one of the following buttons:
    • Download Custom WSDL
    • Download Generic WSDL

      A page containing the WSDL is displayed.

      Depending on whether you select Download Custom WSDL, or Download Generic WSDL, custom fields are displayed differently in the WSDL. For Custom WSDL, the XML tags for the custom fields are based on the Integration tags from Field Setup, see Setting Up Custom Field Integration Tags. Custom WSDL allows you to generate WSDL that is specific to your company and that uses your company's field-naming conventions.

      For Generic WSDL, the custom fields are based on generic XML tags: CustomNumber0, CustomCurrency0, and so on. Using these placeholders, together with the Mapping Service allows applications to map to the field names that your company uses.

  6. Save the WSDL file to your computer.

Downloading Schema Files

The Integration Events Web service uses Schema (XSD) files in its WSDL, which you download in addition to the integrationevents.wsdl file. The WSDL file contains placeholders for the XSD schema files of all record types for which your company currently has active integration event actions defined. Generic WSDL files are available. However, if you create custom fields or rename fields for a record type, then you cannot use the Download Generic Schema button. Instead, you must download an XSD file, using the Download Custom Schema button in the Web Services Administration page. For more information about the Integration Events Web service, see Oracle Web Services On Demand Guide.

To download a schema file

  1. In the upper-right corner of any page, click the Admin global link.
  2. In the Web Service Integration section, click Web Services Administration.
  3. From the Select Service list, select Web Services v1.0 or Web Services v2.0.
  4. From the WSDL Object list, select the required record type, for example, Account.

    The objects displayed in the WSDL Object list depend on the record types that are set up for your company.

  5. Click one of the following buttons:
    • Download Custom Schema
    • Download Generic Schema

      A page containing the schema file is displayed.

      Depending on whether you select Download Custom Schema, or Download Generic Schema, custom fields are displayed differently in the schema. For Custom Schema, the XML tags for the custom fields are based on the integration tags from Field Setup. For Generic Schema, the custom fields are based on generic XML tags.

  6. Save the Schema file to your computer.

Accessing the Web Services Documentation

To access the Web services documentation, click Download Documentation in the title bar on the Web Services Administration page. The Oracle CRM On Demand Documentation page is displayed from which you can access the Web services and other documentation for different Oracle CRM On Demand releases.


Published 5/4/2012 Copyright © 2005, 2012, Oracle. All rights reserved. Legal Notices.