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 mode, perform the following steps in the Web service client program: 1 Call the beginSession() operation of the DrmService to obtain a session ID from the server. The web service client program needs to keep track of this session ID as it will be utilized on subsequent web service calls. 2 Insert the session ID into a custom web service header element named “SessionMaintainParams” with the “http://drm.webservices.epm.oracle” namespace. 3 Perform the desired web service operations. 4 End the stateful session by calling the endSession() operation of the DrmService interface.
Note: The SessionMaintainParams element in the WSDL provides a schema definition for this SOAP header element.
6 Java Example String sessionId = null; if (stateful) { sessionId = i_drmService.beginSession(); //add the Session Id to a custom Header addSessionIdNodeToHeader((WSBindingProvider)i_drmService, sessionId); //get system preferences SystemPreferenceListType listType = i_drmService.getSysPrefs();
// Insert Session ID in Header and call DRG Webservice with same session ID //to create a workflow request template. addSessionIdNodeToHeader((WSBindingProvider)i_drgService, sessionId);
CreateWorkflowRequestResponseType createWorkflowRequest = null; CreateWorkflowRequestType input = new CreateWorkflowRequestType(); input.setRequest(new BaseRequestType()); input.getRequest().setModelName(“New Financial Account”);
//create a "Shell" of a Workflow request createWorkflowRequest = i_drgServiceIF.createWorkflowRequest(input);
//end stateful session i_drmService.endSession(sessionId); }
static void addSessionIdNodeToHeader(WSBindingProvider wsbp, String sessionId) throws ParserConfigurationException { List
DocumentBuilder builder = factory.newDocumentBuilder(); Document document = builder.newDocument(); // Create from whole cloth Element root = document.createElementNS(DRM_SERVICE_NAMESPACE, "SessionMaintainParams"); document.appendChild(root);
Element serverUrlNode = (Element) root.appendChild(document.createElementNS(DRM_SERVICE_NAMESPACE, "sessionId")); serverUrlNode.appendChild(document.createTextNode(sessionId)); Header header = new DOMHeader(root); allHeaders.add(header); } wsbp.setOutboundHeaders(allHeaders); } static final String DRM_SERVICE_NAMESPACE = "http://drm.webservices.epm.oracle";
7 Creating a Web Service Client Using JDeveloper If you are using JDeveloper to develop a Java-based client, refer to "Developing Applications Using Web Services" in the Oracle Fusion Middleware User’s Guide for Oracle JDeveloper.
Upgrading Existing API Programs Existing programs written to use the Data Relationship Management web service API available in previous 11.1.2 releases of the product are compatible with this release with certain exceptions which are documented later in this section. For API programs written against a Oracle Data Relationship Management release prior to 11.1.2, those programs must be manually converted to use the web services API available in this release.
Upgrading 11.1.2.1. API Programs In release 11.1.2.2, there were changes made to some remotable types. Detailed information on each method or type can be found in the 11.1.2.3 Reference.
Changes to Existing Types The following remotable types were changed in the 11.1.2.2 release.
Note: If you are using any of these types in an existing API program using the 11.1.2.1 web service, proxy classes need to be regenerated using the current WSDL for the web service. See Regenerating Web Service Proxy Classes.
Table 1 Changes to Remotable Types in the 11.1.2.2 Release
Type Change
ExportType l Changed characterEncoding element to codepage element l Added elements: runValidationsMode, selectedValidations
ScriptLoadParamsType l columnIndices element is changed to a string list l Added elements: useLabelForPropertyLookup, domainForAddedNodes
DataTypeEnum Added enum elements: Domain, VersionVariable, HierarchyGroup
VersionTypeEnum Variable element added
AddNodeWithProps domainName element added
AddNode domainName element added
AddOrphanNode domainName element added
StartScriptFromFile Changed characterEncoding element to codepage element
8 Changes to Session Params In release 11.1.2.2, the session parameter “TimeZoneID” replaced the “TimeZoneOffset” parameter. Refer to the list of standard time zone IDs.
Regenerating Web Service Proxy Classes Existing API programs using methods, objects, or types changed in the 11.1.2.2 web service API must be manually updated. l If using a JRF-based web service client, refer to the “Developing Applications Using Web Services" section in the Oracle Fusion Middleware User’s Guide for Oracle JDeveloper. l If using a .Net-based web service client, refer to the “Configuring Microsoft WCF/.NET 3.5 Client” section of the Oracle Fusion Middleware Interoperability Guide for Oracle Web Services Manager.
Upgrading Pre-11.1.2 API Programs The following mapping tables can be used to manually upgrade custom API programs from using the multiple .NET web services offered in release 11.1.1 to the single Fusion Middleware web service available in release 11.1.2.1 and later. A separate table is provided for each 11.1.1 web service.
Automator
Table 2 Automator Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method
GetLoadActionItemBatch Not Currently Supported
GetProcessActionsResult getScriptResults
LoadFile startScriptFromFile
LoadLogCriteria getScriptFromLog
LoadNodeModel getScriptFromModel
ProcessActions startScript
StartLoadFileJob startScriptFromFile
StartLoadLogCriteriaJob getScriptFromLog
StartProcessActionsJob startScript
9 BlenderMgr
Table 3 BlenderMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
BlenderByID getBlender
DeleteBlenderProfile deleteBlender
FillBlenderProfiles getBlenderNames getBlender
GetBlendJobResults getBlenderResults
ProcessBlend startBlenderByName
SaveBlenderProfile createBlender updateBlender
StartBlendJob startBlender
CategoryMgr
Table 4 CategoryMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method
AddCategory addPropCategory
DeleteCategory deletePropCategory
ListCategories getPropCategories
ListProperties getPropDefsByCategory
ListUsers getPropCategories
UpdateCategory updatePropCategory
UpdateProperties updatePropCategory
UpdateUsers updatePropCategory
CompareMgr
Table 5 CompareMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
Compare runCompare runCompareByName, startCompare, startCompareByName
Compares getCompareNames
DeleteCriteria deleteCompare
10 Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
LoadCriteria getCompare
PropCompare runCompare runCompareByName, startCompare, startCompareByName
PropCompares getCompare
Rename updateCompare
RenameCompare runCompare runCompareByName, startCompare, startCompareByName
RenameCompares getCompare getCompareNames
SaveCriteria createCompare updateCompare
ExportMgr
Table 6 ExportMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
BookByID getBook
CloseBookJob Not Applicable
DeleteBook deleteBook
DeleteExport deleteExport
ExportByID getExport
FillBooks getBookNames getBook
FillExports getExportNames getExport
FillTypeDefs Not Currently Supported
GetBookJobCombinedFile getBookResults
GetBookJobExportResult getBookResults
GetBookJobItemCount getBookResultsItemCount
GetExportJobResults getExportResults
IsExportRunnable Not Currently Supported
RunExport startExport startExportByName, startCompareExportByName, startCompareExportByNameOnHier, startCompareExportByNameOnHierNode
RunExportByID startExport startExportByName, startCompareExportByName, startCompareExportByNameOnHier, startCompareExportByNameOnHierNode
11 Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
SaveBook createBook updateBook
SaveExport createExport updateExport
StartBookJob startBookByName
StartExportJob startExport startExportByName, startCompareExportByName, startCompareExportByNameOnHier, startCompareExportByNameOnHierNode
GlobalNode
Table 7 GlobalNode Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method
ChildNodeCount getGlobalNodeRefCount
ExistsInDB Not Currently Supported
FillChildren getRelatedNodes
FillChildrenQry getGlobalRelatedNodesWithProps
FillChildrenStrList Not Currently Supported
FillDescendants getRelatedNodes
FillDescendantsQry getRelatedNodesWithProps
FillDescendantsSorted Not Currently Supported
FillPropValue getGlobalNodeProps
FillPropValues getGlobalNodeProps
FillReferencesQry getRelatedNodesWithProps
FillSharedNodes Not Currently Supported
GetAccessLevel Not Applicable
GetLeafAccessLevel Not Applicable
GetLimbAccessLevel Not Applicable
GetNode getGlobalNodes
GetReactivateAccessLevel Not Applicable
GetReactivateLeafAccessLevel Not Applicable
GetReactivateLimbAccessLevel Not Applicable
12 Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method
GetReferenceCount getGlobalNodeRefCount
GetReferences getGlobalNodeReferences
HasChildren getGlobalNodeProps
NextNodeSequence Not Currently Supported
NumChildren getGlobalNodeProps
NumDescendants getGlobalNodeProps
PropOriginByAbbrev getGlobalNodeProps
PropStrValueByAbbrev getGlobalNodePropValues
PropValueByAbbrev getGlobalNodePropValues
PropValueByID getGlobalNodePropValues
PropValuesByAbbrev getGlobalNodePropValues
GlyphMgr
Table 8 GlyphMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method
Delete deleteGlyph
GlyphByID getGlyph
Insert addGlyph
LoadGlyphs Not Currently Supported
Update updateGlyph
Hier
Table 9 Hier Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
AddNode addNode addNodeWithProps
AnnulAllBelow annulNode
AnnulNode annulNode
ChangeTopNode setHierTopNode
13 Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
CopyNodes copyNode
DeleteNodes deleteNodes deleteNode
DestroyNodes deleteNodes deleteNode
ExtNodeByAbbrev Not Currently Supported
ExtNodeByID Not Currently Supported
FillNodeList Not Currently Supported
FillPropValues getHierPropValues getHierProps
FillStrPropValue getHierPropValues getHierProps
GetHier getHier
InactivateNodes inactivateNodes
InsertNode insertNode insertNodes, insertNodeWithProps
MoveNodes moveNodes moveNode
NodeByAbbrev getNode getNodes, getNodeWithProps
NodeByID getNodeByID
PropValueByAbbrev getHierPropValues getHierProps
PropValueByID getHierPropValues getHierProps
ReactivateNodes reactivateNodes reactivateNode
RemoveNodes removeNodes removeNode
SearchForNode searchForNodesInHier
UpdateProps updateHierProps
Verify runValidateHier
VerifyNode runValidateNode
VerifyNodeSelected runValidateNode
VerifySelected runValidateHier
14 ImportMgr
Table 10 ImportMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
DeleteImport deleteImport
FillImportBlocks getImport
FillImportTypeDefs Not Currently Supported
GetImportJobResults getImportResults
ImportBlockByID getImport
IsRunnable Not Currently Supported
RunImport startImport startImportByName
SaveImport updateImport
StartImportJob startImport startImportByName
JobMgr
Table 11 JobMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method
CheckJobStatus getJobStatus
LocalNode
Table 12 LocalNode Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
ChildNodeCount getRelatedNodeCount
CopyProps copyNodeProps
ExistsInDB Not Currently Supported
FillAncestors getRelatedNodes
FillAncestorsExt Not Currently Supported
FillAncestorsExtQry getRelatedNodesWithProps
FillChildren getRelatedNodes
FillChildrenExt Not Currently Supported
15 Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
FillChildrenExtQry getRelatedNodesWithProps
FillChildrenSorted Not Currently Supported
FillChildrenStrList getRelatedNodeNames
FillDescendants getRelatedNodes
FillDescendantsQry getRelatedNodesWithProps
FillDescendantsSorted Not Currently Supported
FillPropValue getNodePropValues
FillPropValues getNodePropValues
FillSiblings getRelatedNodes
FillSiblingsQry getRelatedNodesWithProps
GetAccessLevel getNodeAccessLevel
GetDisplayByString getNodePropValues
GetExtNode Not Currently Supported
GetFiltered Not Currently Supported
GetGlobalNode getGlobalNode getGlobalNodes
GetLeafAccessLevel getNodeAccessLevel
GetLimbAccessLevel getNodeAccessLevel
GetNode getNode getNodes, getNodeWithProps
GetNodeType getNode getNodes
GetNumVisibleChildren Not Currently Supported
GetParentNode getRelatedNodes getNode
GetReactivateAccessLevel Not Currently Supported
GetReactivateLeafAccessLevel Not Currently Supported
GetReactivateLimbAccessLevel Not Currently Supported
HasChildren getRelatedNodeCount
NumChildren getRelatedNodeCount
NumDescendants getRelatedNodeCount
OrderChildren orderChildren
16 Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
PropOriginByAbbrev getNodeProps
PropStrValueByAbbrev getNodePropValues
PropValueByAbbrev getNodePropValues getNodeProps
PropValueByID getNodePropValues
PropValuesByAbbrev getNodePropValues
UpdateProps updateNodeProps updateNodePropValues
Verify runValidateNode
VerifySelected runValidateNode
LogMgr
Table 13 LogMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method
LoadLogItems getLogItems
LogItem Not Currently Supported
NodeAccessGroupMgr
Table 14 NodeAccessGroupMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
AddNodeAccessGroup addNodeAccessGroup
DeleteNodeAccessGroup deleteNodeAccessGroup
FillGroupList getNodeAccessGroupNames getNodeAccessGroup
FillUserList getNodeAccessGroupUserList
GroupByID getNodeAccessGroup
UpdateControllingHiers assignControlledProps
UpdateNodeAccessGroup updateNodeAccessGroup
UpdateNodeAccessMembers updateNodeAccessGroup
17 NodeTypeMgr
Table 15 NodeTypeMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
AddNodeType addNodeType
ApplyNodeTypeCategories Not Currently Supported
ApplyNodeTypeProps Not Currently Supported
ApplyNodeTypeValidations Not Currently Supported
DeleteNodeType deleteNodeType
FillCategoriesByNodeType getNodeTypes
FillNodeTypes getNodeTypes getNodeTypeNames
FillNodeTypesByCategory Not Currently Supported
FillNodeTypesByProperty getNodeTypes
FillNodeTypesByValidation getNodeTypes
FillPropertiesByNodeType getNodeTypes
FillValidationsByNodeType getNodeTypes
GlyphIDByNode Not Currently Supported
GlyphIDByNodeType getNodeTypes
UpdateNodeType Not Currently Supported
ProcessInfo
Table 16 ProcessInfo Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method
GetEngineList Not Applicable
GetEngineProcessID Not Applicable
GetEngineProcessMemoryInfo Not Applicable
GetEngineQueue Not Applicable
GetEngineThreadInfo Not Applicable
GetGlobalMemoryStatus Not Applicable
GetMachineList Not Applicable
18 PropMgr
Table 17 PropMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
AddPropDef addPropDef
AnyPropDefByAbbrev getPropDef
AnyPropDefByID getPropDef
ControlHierID Not Currently Supported
DefaultByAbbrev getPropDef
DeleteLookupValue updatePropDef
DeletePropDef deletePropDef
DerivedClassDefaultParams Not Currently Supported
DerivedClassDefaults Not Currently Supported
FillControlledProps getControlledPropNames
FillFullPropList getPropDefs getPropDefNames
FillHierPropByAbbrev getPropDefs getPropDefNames
FillHierPropDefs getPropDefs getPropDefNames
FillPropByAbbrev getPropDefs getPropDefNames
FillPropDefs getPropDefs
FillPropsFromPref Not Applicable
FillSelectedPropList getPropDefs getPropDefNames
FillValPropList getPropDefs getPropDefNames
FillVersionPropByAbbrev getPropDefs getPropDefNames
FillVersionPropDefs getPropDefs getPropDefNames
GetAccessGroups getNodeAccessGroupNames
GetAccessLevel getPropDefs
GetCategories getPropDefs
GetPropDefParams getPropDefs
HFillFullPropList getPropDefs getPropDefNames
HFillSelectedPropList getPropDefs getPropDefNames
19 Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
HierPropDefByAbbrev getPropDefs
HierPropDefByID getPropDefs
HierPropIsValid getPropDefs
InsertLookupValue updatePropDef
ListControllingHiers Not Currently Supported
ListDerivedPropClasses Not Currently Supported
ListLookupValues getPropDef
ListPropDefParams getPropDef
ListPropsByCategory getPropDefsByCategory
LookupByValue getPropDef
NodeCopyPropByAbbrev Not Currently Supported
NodePropIsValid getPropDef
ParamByName getPropDef
PropDefByAbbrev getPropDef
PropDefByID getPropDef
PropIsValid Not Currently Supported
SetCategoryList updatePropDef
SetControllingHier assignControlledProps
SetPropDefParams updatePropDef
TestFormula Not Currently Supported
UpdateListValues updatePropDefListValues
UpdateLookupValue updatePropDef
UpdatePropDef updatePropDef
VersionPropDefByAbbrev getPropDefs getPropDefNames
VersionPropDefByID getPropDefs
VersionPropIsValid getPropDefs
VFillFullPropList getPropDefs getPropDefNames
VFillSelectedPropList getPropDefs getPropDefNames
20 QueryMgr
Table 18 QueryMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
ComparisonOperators Not Currently Supported
DeleteCriteria deleteQuery
DescrFormula getQuery
GetCriteria getQuery
GetCriteriaByName getQuery
GetParams getQuery
GetParamsByName getQuery
GlobalPropQueries getQueries getQueryNames
IsQueryUsed Not Currently Supported
LocalPropQueries getQueries getQueryNames
ParserFormula getQuery
QueryGlobal runGlobalQuery startQuery
QueryLocal runQuery startQuery
Rename updateQuery
SaveCriteria createQuery, updateQuery
SingleQueryLocal Not Applicable
VerifyFormula Not Currently Supported
RequestMgr
Table 19 RequestMgr Method changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
ApproveRequest approveRequest
DeleteRequest deleteRequest
QueryRequests queryRequests
RequestByExternalID getRequestByExternalId
RequestByID getRequestById
21 Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
SaveRequest createRequest updateRequest
ValidateRequest validateRequest
SessionMgr
Table 20 SessionMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method
AuthenticationMethod Not Applicable
CloseSession Not Applicable
CreateSession Not Applicable
FakeExportSessionInfoArray Not Applicable
ListSessionInfos Not Applicable
PublicKey Not Applicable
SysPref
Table 21 SysPref Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method
AddValue Not Applicable
DeleteValue Not Applicable
GetDBSysPrefs Not Applicable
GetPreferences getSysPrefs
GetSystemValues getSysPrefs
ReadPreferenceValue getSysPrefValue
ReadSystemValue getSysPrefValue
UpdateDBSysPref Not Applicable
UpdateValue Not Currently Supported
22 UserMgr
Table 22 UserMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
AddUser addUser
AssignUserCategories updateUser
AssignUserNodeAccessGroups updateUser
ChangePassword updateUserPassword
CloneUser copyUser
DeleteUser deleteUser
ListUserAccessGroups getUser
ListUserCategories getUser
ListUserNames getUserNames
ListUserObjects getUserNames getUser
SetPassword setUserPassword
UpdateUser updateUser
UpdateUserLockout updateUserLockout
UserByID getUser
UserByName getUser
ValidationMgr
Table 23 ValidationMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
AddValidation addValidation
CheckAssignedValidation getAssignedHierValidations
DeleteValidation deleteValidation
FillAssignedGlobalValidations getAssignedGlobalValidations
FillAssignedHierValidations getAssignedHierValidations
FillAssignedMoveValidations getAssignedHierValidations
FillAssignedNodeValidations getAssignedNodeValidations
23 Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
FillAssignedRemoveValidations getAssignedHierValidations
FillAssignedVersionValidations getAssignedVersionValidations
FillFullValidationList getValidations getValidationNames
FillHierValidationList getValidations getValidationNames
FillNodeValidationList getValidations getValidationNames
FillSelectedValidationList Not Currently Supported
FillValidationParams getValidation
FillValidationParamTemplates Not Applicable
FillValidationTemplates Not Applicable
FillVersionValidationList getValidations getValidationNames
IsHierValAssigned getAssignedHierValidations
IsVersionValAssigned getAssignedVersionValidations
SetValidationParams updateValidation
UpdateHierValidations setHierValidations
UpdateValidation updateValidation
UpdateVersionValidations setVersionValidations
ValidationByAbbrev getValidation
ValidationByID getValidation
ValidationIsValid Not Currently Supported
Version
Table 24 Version Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
AddHierarchy addHier
AddOrphan addOrphanNode
Close closeVersion
DeleteHierarchy deleteHier
DeleteOrphanNodes deleteOrphanNodes
24 Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
DeleteSystemCategory deleteHierGroup
DestroyOrphanNodes deleteOrphanNodes
DisableRTV Not Currently Supported
EnableRTV Not Currently Supported
FillGlobalNodes getGlobalNodes
FillOrphans getOrphanNodes
FillParents getRelatedNodes
FillPropValues getVersionProps
HierByAbbrev getHier
HierByID getHier
ListHierObjects getHiers
ListHierObjectsBySystemCategory getHiers
ListHiers getHierNames
ListHiersBySystemCategory getHierNames
Load openVersion
MergeAbbrevByID Not Currently Supported
MergedAbbrevByID Not Currently Supported
MergedIDByID Not Currently Supported
MergeIDByID Not Currently Supported
MergeLogIDByID Not Currently Supported
NodeByAbbrev getGlobalNode
NodeByID getNodeByID
PropValueByAbbrev getVersionPropValues
PropValueByID getVersionPropValues
RebuildHierNodeTable Not Applicable
Refresh Not Applicable
ReplaceNodeWithNew Not Currently Supported
SearchForNode searchForNodesInVersion
25 Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
UpdateProps updateVersionProps updateVersionPropValues
ValidateAllLocalNodes Not Currently Supported
Verify runValidateVersion
VerifySelected runValidateVersion
VersionInfo
Table 25 VersionInfo Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method
GetVersionInfos Not Applicable
VersionMgr
Table 26 VersionMgr Method Changes
Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
AddSystemCategory addHierGroup
AddVersion addVersion
CloseJob Not Applicable
CopyVersion copyVersion
CreateAsOfDate startCreateVersionAsOfDate
CreateAsOfTxnID startCreateAsOfTxnID
DefaultPreviousVersion Not Currently Supported
DefaultVersion Not Currently Supported
FillVersionNameMasterList getVersionNames
GetCopyVersionResults getCopyVersionResults
GetCreateAsOfResults getCreateVersionAsOfDateResults getCreateVersionAsOfTxnIDResults
HasDisconnectedVersions Not Currently Supported
ListAllHierObjects getHiers
ListSystemCategories getHierGroupNames
ListSystemCategoryObjects getHierGroupNames getHierGroup
26 Pre-11.1.2 Web Service Method 11.1.2.1 Web Service Method Alternate 11.1.2.1 Methods
ListVersionObjects getVersions
ListVersions getVersionNames
StartCopyVersionJob startCopyVersion
StartCreateAsOfDateJob startCreateVersionAsOfDate
StartCreateAsOfTxnIDJob startCreateAsOfTxnID
StartDeleteVersionJob startDeleteVersion
StartSaveVersionJob startSaveVersion
UpdateSystemCategory updateHierGroup
VersionByAbbrev getVersion
VersionByID getVersion
27 COPYRIGHT NOTICE
Data Relationship Management API Guide, 11.1.2.3.500 Copyright © 2000, 2015, Oracle and/or its affiliates. All rights reserved. Updated: May 2015 Authors: EPM Information Development Team This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/ or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.