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 67. 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.

Table 67. Administrative Services
Service
Method
Usage

Access Profile

AccessProfileRead

Administering access profile configuration data.

AccessProfileReadAll

AccessProfileUpsert

Action Bar Custom Web Applet

ActionBarCustomWebAppletRead

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.

ActionBarCustomWebAppletReadAll

ActionBarCustomWebAppletUpsert

Action Bar and Global Header Layouts

ActionBarLayoutReadAll

Administering action bar and global header layout configuration data.

ActionBarLayoutUpsert

Assessment Scripts

SalesAssessmentTemplateRead

Administering assessment script configuration data.

SalesAssessmentTemplateReadAll

SalesAssessmentTemplateUpsert

Assignment Rule

AssignmentRuleRead

Administering assignment rule configuration data.

AssignmentRuleReadAll

AssignmentRuleUpsert

Assignment Rule Group

AssignmentRuleGroupRead

Administering assignment rule group configuration data.

AssignmentRuleGroupReadAll

AssignmentRuleGroupUpsert

Cascading Picklists

CascadingPicklistRead

Administering cascading picklist configuration data.

CascadingPicklistReadAll

CascadingPicklistUpsert

Company Profile

CurrentOrganizationRead

Administering the company profile data.

Concatenated Field

ConcatenatedFieldRead

Administering concatenated field configuration data.

ConcatenatedFieldReadAll

ConcatenatedFieldUpsert

Currency Picklist

CurrencyRead

Administering currency picklist configuration data.

CurrencyReadAll

CurrencyUpsert

Custom HTML Head Tag

CustomHTMLHeadTagRead

CustomHTMLHeadTagUpsert

Administering custom HTML Head tag configuration data.

Customize Record Types

CustomRecordTypeRead

Administering customized record type configuration data.

CustomRecordTypeReadAll

CustomRecordTypeUpsert

Custom Web Link

CustomWebLinkRead

Administering Web link configuration data.

NOTE:  Reading or upserting of the Report and Dashboard types of custom Web link is not supported.

CustomWebLinkReadAll

CustomWebLinkUpsert

Custom Web Tab

CustomWebTabDelete

Administering custom Web tab configuration data.

NOTE:  Reading or upserting of the Report and Dashboard types of custom Web tab is not supported.

CustomWebTabRead

CustomWebTabReadAll

CustomWebTabUpsert

Detail Page Custom Web Applet

DetailPageCustomWebAppletRead

Administering detail page Web applet configuration data.

NOTE:  Reading or upserting of the Report and Dashboard types of custom Web applet is not supported.

DetailPageCustomWebAppletReadAll

DetailPageCustomWebAppletUpsert

Dynamic Layout

DynamicLayoutRead

Administering dynamic page layout configuration data.

DynamicLayoutReadAll

DynamicLayoutUpsert

Enable Modification Tracking

EnableModificationTrackingRead

Administering modification tracking configuration data.

EnableModificationTrackingReadAll

EnableModificationTrackingUpsert

Field Audit Setup

FieldAuditSetupRead

Administering field audit configuration data.

FieldAuditSetupReadAll

FieldAuditSetupUpsert

Field Management

FieldManagementCreate

Administering field management configuration data.

FieldManagementRead

FieldManagementReadAll

FieldManagementUpsert

Homepage Layout

HomepageLayoutReadAll

Administering homepage layout configuration data.

HomepageLayoutUpsert

Home Page Custom Web Applet

HomepageCustomWebAppletRead

Administering homepage Web applet configuration data.

HomepageCustomWebAppletReadAll

HomepageCustomWebAppletUpsert

Home Tab Custom Web Applet

HomeTabCustomWebAppletRead

Administering My Homepage tab Web applet configuration data.

HomeTabCustomWebAppletReadAll

HomeTabCustomWebAppletUpsert

Industry Picklist

IndustryRead

Administering industry configuration data.

IndustryReadAll

Integration Event Queue Management

IntegrationEventQueueRead

Administering integration event queue configuration data.

IntegrationEventQueueReadAll

IntegrationEventQueueUpsert

Lists

ListRead

Administering list configuration data.

ListReadAll

List Access and Order

ListAccessAndOrderRead

Administering list access and order configuration data.

ListAccessAndOrderReadAll

ListAccessAndOrderUpsert

Page Layout Field

PageLayoutFieldRead

Administering field information for page layout configuration data.

PageLayoutFieldReadAll

PageLayoutFieldUpsert

Page Layout Related Information

PageLayoutRelatedInformationRead

Administering related information for page layout configuration data.

PageLayoutRelatedInformationReadAll

PageLayoutRelatedInformationUpsert

Page Layout Section Translation

PageLayoutSectionReadAll

Administering section information for page layout configuration data.

PageLayoutSectionUpsert

Picklist

PicklistRead

Administering picklist configuration data.

PicklistReadAll

PicklistUpsert

Picklist Value Group

PicklistValueGroupRead

Administering picklist value group configuration data.

PicklistValueGroupReadAll

PicklistValueGroupUpsert

Process Administration

ProcessAdministrationRead

Administering process administration configuration data.

ProcessAdministrationReadAll

ProcessAdministrationUpsert

Related Information Layout

RelatedInformationLayoutRead

Administering related information for page layout configuration data.

RelatedInformationLayoutReadAll

RelatedInformationLayoutUpsert

Report Folders

ReportFolderRead

Administering report and dashboard folder configuration data.

ReportFolderReadAll

ReportFolderUpsert

Role Management

RoleRead

Administering role management configuration data.

RoleReadAll

RoleUpsert

Sales Category

SalesCategoryRead

Administering sales category configuration data.

SalesCategoryReadAll

SalesCategoryUpsert

Search Layout

SearchLayoutRead

Administering search layout configuration data.

SearchLayoutReadAll

SearchLayoutUpsert

SSO Token

SSOTokenRead

Obtaining a Single-Sign On (SSO) token.

Workflow Action

WorkflowActionSetRead

Administering workflow action configuration data.

WorkflowActionSetReadForRuleSet

WorkflowActionSetUpsert

WorkflowActionSetInsertOrUpdate

Workflow Rule

WorkflowRuleSetDelete

Administering workflow rule configuration data

WorkflowRuleSetRead

WorkflowRuleSetReadAll

WorkflowRuleSetUpsert

WorkflowRuleSetInsertOrUpdate

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.

Oracle Web Services On Demand Guide, Version 25.0 (Oracle CRM On Demand Release 37) Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.