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 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.
For more information about the downloadable client, see Oracle Migration Tool On Demand Guide.
The Administrative Services and their methods are as shown in the following table. 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>QueryPage. Supported for the Sales Process Administrative Service API and the Sales Stage Administrative Service API. Extracts sales process configuration data.
<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 theOracle 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.
Service | Method | Usage |
---|---|---|
Access Profile |
Administering access profile configuration data. |
|
Action Bar Custom Web Applet |
Administering configuration data for action bar Web applets. Note: Reading or upserting of
the Report and Dashboard types of custom Web applet is not supported. |
|
Action Bar and Global Header Layouts |
Administering action bar and global header layout configuration data. |
|
Assessment Scripts |
Administering assessment script configuration data. |
|
Assignment Rule |
Administering assignment rule configuration data. |
|
Assignment Rule Group |
Administering assignment rule group configuration data. |
|
Cascading Picklists |
Administering cascading picklist configuration data. |
|
Client Side Extension |
Administering client side extensions. |
|
Company Profile |
Administering the company profile data. |
|
Concatenated Field |
Administering concatenated field configuration data. |
|
Currency Picklist |
Administering currency picklist configuration data. |
|
Custom HTML Head Tag |
Administering custom HTML Head tag configuration data. |
|
Customize Record Types |
Administering customized record type configuration data. |
|
Custom Web Link |
Administering Web link configuration data. Note: Reading or upserting of the Report and Dashboard types
of custom Web link is not supported. |
|
Custom Web Tab |
Administering custom Web tab configuration data. Note: Reading or upserting of the Report and
Dashboard types of custom Web tab is not supported. |
|
Detail Page Custom Web Applet |
Administering detail page Web applet configuration data. Note: Reading or upserting of the Report
and Dashboard types of custom Web applet is not supported. |
|
Dynamic Layout |
Administering dynamic page layout configuration data. |
|
Enable Modification Tracking |
Administering modification tracking configuration data. |
|
Field Audit Setup |
Administering field audit configuration data. |
|
Field Management |
Administering field management configuration data. |
|
Homepage Layout |
Administering homepage layout configuration data. |
|
Home Page Custom Web Applet |
Administering homepage Web applet configuration data. |
|
Home Tab Custom Web Applet |
Administering My Homepage tab Web applet configuration data. |
|
Industry Picklist |
Administering industry configuration data. |
|
Integration Event Queue Management |
Administering integration event queue configuration data. |
|
Lead Conversion Mapping |
Administering lead conversion mappings configuration data. |
|
Lists |
Administering list configuration data. |
|
List Access and Order |
Administering list access and order configuration data. |
|
Page Layout Field |
Administering field information for page layout configuration data. |
|
Page Layout Related Information |
Administering related information for page layout configuration data. |
|
Page Layout Section Translation |
Administering information for page layout section configuration data. |
|
Picklist |
Administering picklist configuration data. |
|
Picklist Value Group |
Administering picklist value group configuration data. |
|
Process Administration |
Administering process administration configuration data. |
|
Process Administration Transition State |
Administering process administration transition state configuration data. |
|
Related Information Layout |
Administering related information for page layout configuration data. |
|
Report Folders |
Administering report and dashboard folder configuration data. |
|
Role Management |
Administering role management configuration data. |
|
Sales Category |
Administering sales category configuration data. |
|
Sales Process |
Administering sales process configuration data. |
|
Sales Stage |
Administering sales stage configuration data. |
|
Search Layout |
Administering search layout configuration data. |
|
SSO Token |
Obtaining a Single-Sign On (SSO) token. |
|
Workflow Action |
Administering workflow action configuration data. |
|
Workflow Rule |
Administering workflow rule configuration data |
|
Workflow User |
Administering workflow user set configuration data |
|
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 as described in the Oracle Migration Tool On Demand Guide. 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.