Oracle Web Services On Demand Guide > Web Services On Demand API Calls >

Administrative Services API Calls

The Administrative Services are used to automate the administration of your company's configurations. The Oracle Migration Tool On Demand client is the command-line based utility that eliminates the need to manually copy customized configurations from one environment to another. You can use this downloadable client to extract and import specific configuration details and the Administrative Web services provide programmatic access to the configurations.

NOTE:  The Administrative Services must be enabled for your company. To request enablement of the Administrative Services, contact Customer Care.

For more information about the downloadable client, see Oracle Migration Tool On Demand Guide.

The Administrative Services and their methods are as shown in Table 64. There are the following methods for services, though not all services have each method, as shown in the table:

• <Configuration>Read. Extracts configuration data matching the input criteria.
• <Configuration>ReadAll. Extracts all configuration data of a particular type for a company.
• <Configuration>Upsert. Updates existing configuration data or inserts it, if it does not exist. You can update or insert multiple items within an Upsert call.
• <Configuration>Create. Creates configuration data.
• <Configuration>Delete. Deletes configuration data.

For access to configuration data, various privileges are required, depending on the type of data. The privileges are detailed in the Oracle Migration Tool On Demand Guide and are also mentioned in specific topics in this chapter. Users with an Administrator role will have the necessary privileges to use all of the Administrative Services, although read-only access to some configuration data is available for users who are not administrators, see Access to the Administrative Services APIs for Nonadministrative Users.

The Administrative Services do not support stateful login mechanisms, that is, Single Sign-on (SSO), and use of session IDs to authenticate users. For more information about stateful versus stateless session management, see Establishing and Managing the Web Services Session.

You can download the WSDL file for each service from the Web Services Administration page in the Oracle CRM On Demand application.

All Web Service operations for the Administrative Services are audited automatically. The audits include all successful operations as well as processing errors such as Request Size exceeded, Invalid SOAP request, Rate limit error, and so on. You can find the audit records in the Web Services Utilization page in Oracle CRM On Demand (click Admin, and then Web Services Utilization).

You can view logs for the Oracle Migration Tool On Demand client in the <Installation directory>\log directory, for example, C:\Oracle Migration Tool On Demand\log. Any requests by the client are also captured in the Web Services Utilization page in Oracle CRM On Demand.

The following topics describe each of the methods.