ORACLE® DATA RELATIONSHIP MANAGEMENT Release 11.1.2.3.500 API Guide CONTENTS IN BRIEF Overview ............................................................ 2 Using the Data Relationship Management Web Services .......................... 2 Creating a Web Service Client Using JDeveloper ................................ 8 Upgrading Existing API Programs .......................................... 8 Overview The Oracle Data Relationship Management web services provide public interfaces for remotely interacting with a Data Relationship Management server. The SOAP-based web services can be used for product integration or developing custom applications which require a programmable interface. Data Relationship Management includes two web service modules: l DrmService–The primary interface for accessing and managing information in Data Relationship Management m Master Data Objects–Includes versions, hierarchies, nodes, and properties. The Data Relationship Management web service API includes a complete set of interfaces to create, retrieve, maintain, and save these objects. Each object has a standard set of functionality along with operations specialized for that object type. m User Metadata Objects–Includes imports, blenders, queries, compares, exports, books, action scripts, and version variables. The interface includes operations for retrieving, editing, running, and interrogating the results of these objects. m System Metadata and Security Objects–Objects that the administrator develops as part of the implementation to determine how an application will function and who can access which features and data. These objects include domains, property definitions and categories, validations, hierarchy groups, node types, system preferences, external connections, workflow models and tasks, users and access groups. The interface provides limited support for the maintenance of these objects. Generally, these objects will be administered using the Data Relationship Management web client. l DrmGovernanceService–A specialized interface for processing workflow requests using Oracle Data Relationship Governance Workflow Data Objects–Includes the ability to create, read, update, delete, validate, and submit workflow requests using workflow models. Using the Data Relationship Management Web Services Data Relationship Management web service modules each provide their own web service interface, which is defined by a Web Service Definition Language (WSDL) document. The WSDL documents for the Data Relationship Management web service interfaces are accessible using the following URLs (substitute the appropriate server hostname:port): http://web_server_name:port_number/oracle-epm-drm-webservices/ DrmService?wsdl http://web_server_name:port_number/oracle-epm-drm-webservices/ DrmGovernanceService?wsdl The API Reference for each web service interface provides details of the web service interface including descriptions and examples of operations, types, and parameters: Data Relationship Management API Reference 2 Data Relationship Governance API Reference Connecting to a Data Relationship Management Application All Data Relationship Management web service operations require a connection to a Data Relationship Management application. Connection information must be passed as a SOAP header element for each web service call. The AppParameters element in the WSDL provides a schema definition for this SOAP header element. The AppParameters SOAP header element contains the following information which is needed to connect to the API Adapter for a Data Relationship Management application: l serverUrl–URL for the API Adapter configured for a Data Relationship Management application. For example: http://localhost:5240/Oracle/Drm/APIAdapter l sessionParams–Parameters for the Data Relationship Management user session: m ProductVersion–Version number for the Data Relationship Management application m CultureName–Identifier for formatting date, time, and decimal values which are sent to or retrieved from a Data Relationship Management application. Any standard specific culture can be specified. m UICultureName–Identifies the language used for localized labels and messages returned by the Data Relationship Management application: o en-US (English) o fr-FR (French) o de-DE (German) o ja-JP (Japanese) o zh-CN (Simplified Chinese) o ko-KR (Korean) m TimeZoneID–Client time zone identifier (see list of standard time zone IDs below). Examples of sessionParams: "ProductVersion=11.1.2,CultureName=en-US,UICultureName=en-US,TimeZoneID=Eastern Standard Time" "ProductVersion=11.1.2,CultureName=fr-CA,UICultureName=fr-FR,TimeZoneID=Eastern Standard Time" "ProductVersion=11.1.2,CultureName=en-ZA,UICultureName=en-US,TimeZoneID=South Africa Standard Time" "ProductVersion=11.1.2,CultureName=zh-HK,UICultureName=zh-CN,TimeZoneID=China Standard Time" "ProductVersion=11.1.2,CultureName=en-GB,UICultureName=en-US,TimeZoneID=China Standard Time" 3 Time Zone IDs The following time zone IDs may be used: Time Zone Time Zone Afghanistan Standard Time Mauritius Standard Time Alaskan Standard Time Mid-Atlantic Standard Time Arab Standard Time Middle East Standard Time Arabian Standard Time Montevideo Standard Time Arabic Standard Time Morocco Standard Time Argentina Standard Time Mountain Standard Time Atlantic Standard Time Mountain Standard Time (Mexico) AUS Central Standard Time Myanmar Standard Time AUS Eastern Standard Time N. Central Asia Standard Time Azerbaijan Standard Time Namibia Standard Time Azores Standard Time Nepal Standard Time Bahia Standard Time New Zealand Standard Time Bangladesh Standard Time Newfoundland Standard Time Canada Central Standard Time North Asia East Standard Time Cape Verde Standard Time North Asia Standard Time Caucasus Standard Time Pacific SA Standard Time Cen. Australia Standard Time Pacific Standard Time Central America Standard Time Pacific Standard Time (Mexico) Central Asia Standard Time Pakistan Standard Time Central Brazilian Standard Time Paraguay Standard Time Central Europe Standard Time Romance Standard Time Central European Standard Time Russian Standard Time Central Pacific Standard Time SA Eastern Standard Time Central Standard Time SA Pacific Standard Time Central Standard Time (Mexico) SA Western Standard Time China Standard Time Samoa Standard Time 4 Time Zone Time Zone Dateline Standard Time SE Asia Standard Time E. Africa Standard Time Singapore Standard Time E. Australia Standard Time South Africa Standard Time E. Europe Standard Time Sri Lanka Standard Time E. South America Standard Time Syria Standard Time Eastern Standard Time Taipei Standard Time Egypt Standard Time Tasmania Standard Time Ekaterinburg Standard Time Tokyo Standard Time Fiji Standard Time Tonga Standard Time FLE Standard Time Turkey Standard Time Georgian Standard Time Ulaanbaatar Standard Time GMT Standard Time US Eastern Standard Time Greenland Standard Time US Mountain Standard Time Greenwich Standard Time UTC GTB Standard Time UTC+12 Hawaiian Standard Time UTC-02 India Standard Time UTC-11 Iran Standard Time Venezuela Standard Time Israel Standard Time Vladivostok Standard Time Jordan Standard Time W. Australia Standard Time Kaliningrad Standard Time W. Central Africa Standard Time Kamchatka Standard Time W. Europe Standard Time Korea Standard Time West Asia Standard Time Libya Standard Time West Pacific Standard Time Magadan Standard Time Yakutsk Standard Time Attaching a Web Service Security Policy Data Relationship Management web services are secured using security policies in Oracle Web Services Manager. A client policy must be used by the web service client which matches the 5 security policy configured for the web service being called. JRF-based web service clients must attach one of the following client-side policies when making calls to the Data Relationship Management web services: l oracle/wss11_saml_token_with_message_protection_client_policy l oracle/wss11_username_token_with_message_protection_client_policy l oracle/wss_username_token_client_policy l oracle/wss_http_token_client_policy For more information on configuring a web service security policy, refer to the “Securing Data Relationship Management Web Services” section of the Oracle Data Relationship Management Installation Guide. For information on configuring security for a WCF/.NET 3.5 Client, refer to the “Configuring Microsoft WCF/.NET 3.5 Client” section of the Oracle Fusion Middleware Interoperability Guide for Oracle Web Services Manager. Stateful Session Management Data Relationship Management web services support an optional stateful session mode which may be used as an alternative to the stateless mode available by default. In the stateless mode, each web service operation implicitly creates a user session at the start of the operation and terminates the session at the end of the operation. In the stateful mode, the web service client is responsible for explicitly creating the user session, managing a session ID for the session, and terminating the session. When multiple web service operations need to be performed to complete a particular task, the stateful session mode is beneficial because it minimizes the overhead of creating and terminating user sessions. Creation and termination operations for stateful sessions are included in the DrmService web service interface. If stateful session support is required for the DrmGovernanceService, proxies for both interfaces must be generated to utilize the beginSession and endSession methods in the DrmService interface. ä To use the stateful session