Oracle® Hyperion Data Relationship Management, Fusion Edition

Release 11.1.2.2.000

Web Service API Developer's Guide

Overview.. 2

About the Data Relationship Management Web Service. 2

Using the Data Relationship Management Web Service. 3

Time Zone IDs. 4

Using JDeveloper to Create a Web Service Client 6

New Features in This Release. 6

Methods. 6

Types. 6

Upgrading Existing API Programs. 7

Upgrading 11.1.2.1 API Programs. 7

Changes to Existing Types 7

Regenerating Web Service Proxy Classes 7

Upgrading Pre-11.1.2 API Programs. 8

Automator 8

BlenderMgr 8

CategoryMgr 8

CompareMgr 9

ExportMgr 9

GlobalNode. 10

GlyphMgr 11

Hier 11

ImportMgr 12

JobMgr 13

LocalNode. 13

LogMgr 14

NodeAccessGroupMgr 14

NodeTypeMgr 15

ProcessInfo. 15

PropMgr 15

QueryMgr 17

RequestMgr 18

SessionMgr 18

SysPref 18

UserMgr 19

ValidationMgr 19

Version. 20

VersionInfo. 21

VersionMgr 22

 

Overview

The Oracle® Hyperion Data Relationship Management Web Service API contains most of the functionality available in the user interface. The services can be broken down into three major categories:

·         Master Data Objects - Include 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 services along with services specialized for that object type.

·         User Metadata Objects - Include imports, blenders, queries, compares, exports, books, action scripts, and version variables. The Web Service API includes services for retrieving, editing, running, and interrogating the results of these objects.

·         System Metadata and Security Objects - Objects that the administrator develops as part of the implementation and used by the Data Relationship Management server to determine how it 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, users and node access groups. The Data Relationship Management Web Service API has limited support for the maintenance of these objects. Generally, these objects will be created, edited, or deleted using the Data Relationship Management user interface.

Top of Document

About the Data Relationship Management Web Service

The Data Relationship Management Web Service Application Programming Interface (API) is the public interface for remotely interacting with the Data Relationship Management Server. This SOAP-based web service can be used for product integration or to develop custom Data Relationship Management applications or clients.

The Data Relationship Management Web Service is implemented in Java and is deployed to the Oracle WebLogic Application Server as a J2EE Web Application. The Web Service communicates with the Data Relationship Management Server via the API Adapter. The Data Relationship Management Web Service depends on the Oracle Web Services Manager (OWSM) for policy management and security of service infrastructure.

See the “Deploying and Configuring the Data Relationship Management Web Service API” chapter of the Oracle Hyperion Data Relationship Management Installation Guide for details on the deployment and configuration procedures for the Data Relationship Management Web Service API.

Top of Document

Using the Data Relationship Management Web Service

A Web service interface is defined by a Web Service Definition Language (WSDL) document. Following is the typical URL to the Data Relationship Management Web Service WSDL (substitute the appropriate server hostname:port):

http://<web_server_name>:8001/oracle-epm-drm-webservices/DrmService?wsdl

The Oracle Hyperion Data Relationship Management API Reference (drm_api_ref_11122.html) provides details of the Web service interface including a description of operations and their parameters.

The Data Relationship Management Web Service is stateless. Each Web service call executes within its own Oracle® Hyperion Data Relationship Management session. A new session is created at the beginning of each call and closed at the end of the call.

The Web Service API is secured using Web service security (WS-*) mechanisms. Web service clients must attach one of the following policies when making calls to the Data Relationship Management Web Service:

wss11_saml_token_with_message_protection_client_policy

wss11_username_token_with_message_protection_client_policy

wss_username_token_service_policy

wss_http_token_service_policy

 

Connection information must be passed as a SOAP header for each Web service call. The AppParameters element, defined in the DrmService.wsdl document, provides a schema definition for this SOAP header. The AppParameters SOAP header contains the following information which is needed to connect to the Data Relationship Management API Adapter:

·         serverUrl -­ URL for the API adapter configured for a Data Relationship Management application 

For example: http://localhost:5240/Oracle/Drm/APIAdapter

·         sessionParams­­ - Parameters for the Data Relationship Management user session

The sessionParams that are available are:

 

o    ProductVersion - Version number for the Data Relationship Management application

o    CultureName - Identifier for formatting date, time, and decimal values. Any standard specific culture can be specified.

o    UICultureName – Identifier for language selection to use for exception messages from the Data Relationship Management application server:

§  en-US (English)

§  fr-FR (French)

§  de-DE (German)

§  ja-JP (Japanese)

§  zh-CN (Simplified Chinese)

§  ko-KR (Korean)

o    TimeZoneID – Client TimeZone identifier (see list of standard time zone IDs below)

 

sessionParams example:

ProductVersion=11.1.2

CultureName=en-US

UICultureName=fr-FR

TimeZoneID=Tokyo Standard Time

Time Zone IDs

The following time zone IDs may be used:

Afghanistan Standard Time
Alaskan Standard Time
Arab Standard Time
Arabian Standard Time
Arabic Standard Time
Argentina Standard Time
Atlantic Standard Time
AUS Central Standard Time
AUS Eastern Standard Time
Azerbaijan Standard Time
Azores Standard Time
Bahia Standard Time
Bangladesh Standard Time
Canada Central Standard Time
Cape Verde Standard Time
Caucasus Standard Time
Cen. Australia Standard Time
Central America Standard Time
Central Asia Standard Time
Central Brazilian Standard Time
Central Europe Standard Time
Central European Standard Time
Central Pacific Standard Time
Central Standard Time
Central Standard Time (Mexico)
China Standard Time
Dateline Standard Time
E. Africa Standard Time
E. Australia Standard Time
E. Europe Standard Time
E. South America Standard Time
Eastern Standard Time
Egypt Standard Time
Ekaterinburg Standard Time
Fiji Standard Time
FLE Standard Time
Georgian Standard Time
GMT Standard Time
Greenland Standard Time
Greenwich Standard Time
GTB Standard Time
Hawaiian Standard Time
India Standard Time
Iran Standard Time
Israel Standard Time
Jordan Standard Time
Kaliningrad Standard Time
Kamchatka Standard Time
Korea Standard Time
Magadan Standard Time
Mauritius Standard Time
Mid-Atlantic Standard Time
Middle East Standard Time
Montevideo Standard Time
Morocco Standard Time
Mountain Standard Time
Mountain Standard Time (Mexico)
Myanmar Standard Time
N. Central Asia Standard Time
Namibia Standard Time
Nepal Standard Time
New Zealand Standard Time
Newfoundland Standard Time
North Asia East Standard Time
North Asia Standard Time
Pacific SA Standard Time
Pacific Standard Time
Pacific Standard Time (Mexico)
Pakistan Standard Time
Paraguay Standard Time
Romance Standard Time
Russian Standard Time
SA Eastern Standard Time
SA Pacific Standard Time
SA Western Standard Time
Samoa Standard Time
SE Asia Standard Time
Singapore Standard Time
South Africa Standard Time
Sri Lanka Standard Time
Syria Standard Time
Taipei Standard Time
Tasmania Standard Time
Tokyo Standard Time
Tonga Standard Time
Turkey Standard Time
Ulaanbaatar Standard Time
US Eastern Standard Time
US Mountain Standard Time
UTC
UTC+12
UTC-02
UTC-11
Venezuela Standard Time
Vladivostok Standard Time
W. Australia Standard Time
W. Central Africa Standard Time
W. Europe Standard Time
West Asia Standard Time
West Pacific Standard Time
Yakutsk Standard Time

Top of Document

Using JDeveloper to Create a Web Service Client

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.

Top of Document

New Features in This Release

Methods

The following methods are new in this release:

·         addDomain

·         updateDomain

·         deleteDomain

·         getDomainByName

·         getDomains

·         getExport

·         getExportDefs

·         getExportDimensionTree

·         getVersionObjectNames

·         getVersionObjects

·         getVersionVariable

·         getVersionVariables

·         setVersionVariable

·         startVersionMigrationExport

·         startVersionMigrationImport

·         getVersionMigrationExportResults

·         getVersionMigrationImportResults

Types

The following types are new in this release:

·         DomainType

·         AddDomain

·         UpdateDomain

·         ExportDefType

·         BaseDefType

·         DomainValidationAssignmentListType

·         DomainValidationAssignmentType

·         ExportDimensionTreeType

·         EpmaTargetApplicationEnum

·         ExportDimensionTreeNodeListType

·         ExportDimensionTreeNode

·         VersionVariableType

·         ExportRunValidationModeEnum

·         AutoIncrementIdColumnType

·         EPMArchitectExportColumnType

·         EPMArchitectExportColumnArrayPropItemListType

·         EPMArchitectExportColumnArrayPropItemType

·         EPMArchitectExportType

Top of Document

Upgrading Existing API Programs

Upgrading 11.1.2.1 API Programs

The API changes in this release are noted below. Detailed information on each method or type can be found in the 11.1.2.2 API Reference.

Changes to Existing Types

The following remotable types have been changed in this 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 WSDL for the 11.1.2.2 Web service. See Regenerating Web Service Proxy Classes instructions.

Type

Change

ExportType

·         Changed characterEncoding element to codepage element

·         Added elements: runValidationsMode, selectedValidations

ScriptLoadParamsType

·         columnIndices element is changed to a string list

·         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

 

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. 

 

Ø To regenerate proxy classes for the Workflow Development Kit:

  1. Retrieve the WSDL of the Data Relationship Management Web service from a Web browser.
  2. Save the WSDL to a file named DrmService.wsdl in the following directory of the Workflow Development Kit package:

DrmWdk\source\common\DrmWebServiceProxy\wsdl

 

  1. In JDeveloper, open the DrmWdkRequestApp application.
  2. Expand DrmWebServiceProxy, then Resources.
  3. Right click build xml, and then select Run Ant Target, and then generate_client_proxy.

 

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

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

BlenderMgr

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

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

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

 

LoadCriteria

getCompare

 

PropCompare

runCompare

runCompareByName, startCompare, startCompareByName

PropCompares

getCompare

 

Rename

updateCompare

 

RenameCompare

runCompare

runCompareByName, startCompare, startCompareByName

RenameCompares

getCompare

getCompareNames

SaveCriteria

createCompare

updateCompare

ExportMgr

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

SaveBook

createBook

updateBook

SaveExport

createExport

updateExport

StartBookJob

startBookByName

 

StartExportJob

startExport

startExportByName, startCompareExportByName, startCompareExportByNameOnHier, startCompareExportByNameOnHierNode

GlobalNode

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

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

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

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

 

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

 

ImportMgr

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

Pre-11.1.2 Web Service Method

11.1.2.1 Web Service Method

CheckJobStatus          

getJobStatus

LocalNode

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

 

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

 

PropOriginByAbbrev

getNodeProps

 

PropStrValueByAbbrev

getNodePropValues

 

PropValueByAbbrev

getNodePropValues

getNodeProps

PropValueByID

getNodePropValues

 

PropValuesByAbbrev

getNodePropValues

 

UpdateProps

updateNodeProps

updateNodePropValues

Verify

runValidateNode

 

VerifySelected

runValidateNode

 

LogMgr

Pre-11.1.2 Web Service Method

11.1.2.1 Web Service Method

LoadLogItems

getLogItems

LogItem

Not Currently Supported

NodeAccessGroupMgr

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

 

NodeTypeMgr

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

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

PropMgr

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

getPropDefNames

FillPropsFromPref

Not Applicable

 

FillSelectedPropList

getPropDefs

getPropDefNames

FillValPropList

getPropDefs

getPropDefNames

FillVersionPropByAbbrev

getPropDefs

getPropDefNames

FillVersionPropDefs

getPropDefs

getPropDefNames

GetAccessGroups

getNodeAccessGroupNames

 

GetAccessLevel

getPropDef

 

GetCategories

getPropDef

 

GetPropDefParams

getPropDef

 

HFillFullPropList

getPropDefs

getPropDefNames

HFillSelectedPropList

getPropDefs

getPropDefNames

HierPropDefByAbbrev

getPropDef

 

HierPropDefByID

getPropDef

 

HierPropIsValid

getPropDef

 

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

getPropDef

 

VersionPropIsValid

getPropDef

 

VFillFullPropList

getPropDefs

getPropDefNames

VFillSelectedPropList

getPropDefs

getPropDefNames

QueryMgr

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

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

 

SaveRequest

createRequest

updateRequest

ValidateRequest

validateRequest

 

SessionMgr

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

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

UserMgr

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

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

 

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

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

 

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

 

UpdateProps

updateVersionProps

updateVersionPropValues

ValidateAllLocalNodes

Not Currently Supported

 

Verify

runValidateVersion

 

VerifySelected

runValidateVersion

 

VersionInfo

Pre-11.1.2 Web Service Method

11.1.2.1 Web Service Method

GetVersionInfos

Not Applicable

VersionMgr

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

ListVersionObjects

getVersions

 

ListVersions

getVersionNames

 

StartCopyVersionJob

startCopyVersion

 

StartCreateAsOfDateJob

startCreateVersionAsOfDate

 

StartCreateAsOfTxnIDJob

startCreateAsOfTxnID

 

StartDeleteVersionJob

startDeleteVersion

 

StartSaveVersionJob

startSaveVersion

 

UpdateSystemCategory

updateHierGroup

 

VersionByAbbrev

getVersion

 

VersionByID

getVersion

 

 

Top of Document