Print      Open PDF Version of Online Help

Administering Oracle CRM On Demand > Data Management Tools > Import and Export Tools > Web Services Integration > Downloading WSDL and Schema Files

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, as well as their custom Web applets. 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 for Web Services v1.0 and Web Services v2.0

You can download a WSDL file for each record type and you can choose the child record types to include in the WSDL file for the parent record type.

To download a WSDL file for Web Services v1.0 and Web Services v2.0

  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 as required.
  4. From the Document list, select WSDL.
  5. From the Type list, select Custom or Generic.

    Depending on whether you select Custom or Generic, 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. 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. All of the child record types for the selected record type are displayed, in alphabetical order, in the Available Related Information list, regardless of whether you have access to the child record types. For Web Services v2.0, CustomWebApplet is also displayed.

  7. Move the child record types that you wish to include in the WSDL from the Available Related Information list to the Selected Related Information list.
  8. Click the Download button.
  9. Save the WSDL file to your computer.

Downloading WSDL Files for Service APIs

You can download WSDL files for each of the service APIs. If you download the WSDL for Integration Event, you must additionally download the Schema files for each of the record types for which you wish to generate integration events, see the "Downloading Schema Files for Integration Events" section.

To download a WSDL file for Service APIs

  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 Service APIs.

    NOTE: If you select the Merge Service API, you can select Custom or Generic from the Type list and download a Schema file for this Service API.

  4. From the Type list, select Custom or Generic.
  5. From the WSDL Object list, select the required name of the Service API.
  6. Click the Download button.
  7. Save the WSDL file to your computer.

Downloading WSDL Files for Administrative Services

You can download WSDL files for each Administrative service.

NOTE: To download the Assessments Scripts WSDL or the Access Profile WSDL, your user role must include the Manage Roles and Access privilege.

To download a WSDL file for Administrative Services

  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 Administrative Services.
  4. From the WSDL Object list, select the required service..
  5. Click the Download button.
  6. Save the WSDL file to your computer.

Downloading Schema Files for Integration Events

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 Schema files are available. However, if you create custom fields or rename fields for a record type, then you must download a Custom Schema. For more information about the Integration Events Web service, see Oracle Web Services On Demand Guide.

To download a Schema file for integration events

  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 Document list, select Schema.
  5. From the Type list, select Custom or Generic.

    Depending on whether you select Custom or Generic, custom fields are displayed differently in the Schema file. 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. 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.

  7. From the Select Related Information list, select the child record types that you wish to include in the Schema.
  8. Click the Download button.
  9. Save the Schema file to your computer.

Accessing the Web Services Documentation

To access the Web services documentation, click Release 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 7/3/2018 Copyright © 2005, 2018, Oracle. All rights reserved. Legal Notices.