public interface

IDSSXMLObjectServer

com.microstrategy.webapi.IDSSXMLObjectServer

Class Overview

Provides the interface for an application to retrieve objects by object ID or search criteria.

Summary

Nested Classes
interface IDSSXMLObjectServer.StringFormatAndErrorData  
Constants
int DEFAULT_FindObject_blockBegin Default value for the blockBegin parameter of the FindObject method
int DEFAULT_FindObject_blockCount Default value for the blockCount parameter of the FindObject method
int DEFAULT_FindObject_flags Default value for the flags parameter of the FindObject method
int DEFAULT_FindObject_level Default value for the level parameter of the FindObject method
int DEFAULT_FindObject_type Default value for the type parameter of the FindObject method
int DEFAULT_GetSearchResults_blockBegin Default value for the blockBegin parameter of the GetSearchResults method
int DEFAULT_GetSearchResults_blockCount Default value for the blockCount parameter of the GetSearchResults method
int DEFAULT_GetSearchResults_objectFlags Default value for the objectFlags parameter of the GetSearchResults method
int DEFAULT_getRoot_blockBegin Default value for the blockBegin parameter of the getRoot method
int DEFAULT_getRoot_blockCount Default value for the blockCount parameter of the getRoot method
int DEFAULT_getRoot_flags Default value for the flags parameter of the getRoot method
int DEFAULT_getRoot_level Default value for the level parameter of the getRoot method
Public Methods
abstract void ApplyRuntimeSettings(String sessionID)
This method will cause the Intelligence Server to reload it's ServerDef object from the metadata.
abstract String CertifyObject(String sessionID, String objectID, int objectType, int certify, int resultFlag)
This method handles the certify and decertify of the object(only support document and report now).
abstract String ChangeFeatureStatus(String sessionID, String deltaXML)
This method is used to change the status of features@return
abstract String ChangeJournalCommon(String sessionID, int type, String extParams)
This method purge/enable/disable change journal.
abstract String ChangeJournalSearch(String sessionID, int maxEntries, String searchContentXML)
This method finds a set of DSS objects with the given conditions.
abstract String ChangeObjectID(String sessionID, String objectId, int type, String newId)
This method changes DSS ID of the given object.
abstract String CopyObject(String sessionID, String objectID, int objectType, int flags, String newName, String folderDID)
This method is used to create a copy of an existing object in the metadata.
abstract String CreateFolder(String sessionID, String folderName, String parentFolderID, String folderDesc)
This method creates an empty folder in metadata.
abstract void DeleteLinkItems(String sessionID, String requestXML)
This method is used to delete link items on the Intelligence Server.
abstract void DeleteObject(String sessionID, String objectID, int objectType)
This method deletes an object.
abstract void DeletePalette(String sessionID, String paletteID)
This method deletes an object.
abstract void ExecuteBulkSave(String sessionID, String objectXML)
This method is used to submit bulk save.
abstract String FindObject(String sessionID, String messageID, String objectID, int type, int flags, int level, int blockBegin, int blockCount, int propertyFlags, String extParams)
abstract String FindObject(String sessionID, String objectID, int type, int flags, int level, int blockBegin, int blockCount, int propertyFlags, String extParams, boolean isLeanObject)
Retrieves the representation of an object in XML.
abstract String FindObject(String sessionID, String objectID, int type, int flags, int level, int blockBegin, int blockCount)
Retrieves the representation of an object in XML.
abstract String FindObject(String sessionID, String objectID, int type, int flags, int level, int blockBegin, int blockCount, int propertyFlags)
Retrieves the representation of an object in XML.
abstract String FindObject(String sessionID, String messageID, String objectID, int type, int flags, int level, int blockBegin, int blockCount, int propertyFlags, String extParams, boolean isLeanObject, boolean needThumbnail)
abstract String FindObject(String sessionID, String objectID, int type, int flags, int level, int blockBegin, int blockCount, int propertyFlags, String extParams)
Retrieves the representation of an object in XML.
abstract String FindObject(String sessionID, String messageID, String objectID, int type, int flags, int level, int blockBegin, int blockCount, int propertyFlags, String extParams, boolean isLeanObject)
abstract String FindObjectByPath(String sessionID, int type, int flags, int level, int blockBegin, int blockCount, String fullPath, int searchFlags)
Retrieves the representation of an object in XML.
abstract String FindObjectByPath(String sessionID, int type, int flags, int level, int blockBegin, int blockCount, String fullPath)
Retrieves the representation of an object in XML.
abstract String GetChangeJournalSearchResults(String sessionID, String searchID, IntWrapper status, int blockBegin, int blockCount)
This method retrieves the results of a change journal search.
abstract String GetConfiguredDSNs(String sessionID)
Returns XML containing a list of Data Source Names configured on the I-Server machine.
abstract String GetCubeSecurityFilters(String sessionID, String userID, String cubeID)
This method get the cube's security filters.
abstract String GetDependencies(String sessionID, String objectID, int objectType, int objectSubType, int detailFlag)
This method retrieves the results of dependency search.
abstract String GetDimensionAttributeLock(String sessionID, String dimensionID)
Returns XML containing the System Dimension Attributes that have lock properties specified
abstract String GetFeatureInfos(String sessionID)
This method retrieves the information of all features.
abstract String GetFilterExpression(String sessionID, String commandXML)
Returns the filter expression that the given filter expression resolves into.
abstract String GetFlexProperties(String sessionID)
abstract String GetFolderID(String sessionID, int folderName, int requestTimeout)
This method returns the ID of a special folder with specified request timeout.
abstract String GetFolderID(String sessionID, int folderName)
This method returns the ID of a special folder.
abstract String GetLinkItems(String sessionID, String requestXML, int blockBegin, int blockCount, int flags)
This method is used to retrieve link items from the Intelligence Server.
abstract String GetProperties(String sessionID, String requestXML, int flags)
Gets a property set from the server.
abstract String GetPublishInfo(String sessionID, String objectID)
This method will provide the publish information for an object, if unpublished an empty response xml will be returned
abstract String GetQuickSearchStatus(String sessionID, int qscmd)
Returns XML containing quick search status.
abstract String GetRootExpression(String sessionID, String metricID)
Returns the root expression of the specified metric.
abstract String GetSearchResults(String sessionID, String searchID, int objectFlags, int blockBegin, int blockCount, StringWrapper searchObject, IntWrapper status)
This method retrieves the results of a search.
abstract String GetSearchResults(String sessionID, String searchID, int objectFlags, boolean treeInfo, int blockBegin, int blockCount, StringWrapper searchObject, IntWrapper status, int searchType)
Add a new parameter 'searchType' to send as a flag to backend to stop putting 'folder' objects at top of search results.
abstract String GetSearchResults(String sessionID, String searchID, int objectFlags, boolean treeInfo, int blockBegin, int blockCount, StringWrapper searchObject, IntWrapper status)
This method retrieves the results of a search.
abstract String GetSearchSuggestions(String sessionID, String searchKey, int blockCount, int localeId)
Returns XML containing a list of search suggestions based on the search key provided.
abstract String GetServerDef(String sessionID)
This method returns the ServerDef which is currently being used by a running server.
abstract String GetServerDefID(String sessionID)
This method returns the DSSID of the ServerDef which is currently being used by a running server.
abstract byte[] GetSourceManipulatorDelta(String sessionID, String manipulationXML)
Invoke the source manipulator to return a metadata delta package.
abstract String GetSystemFunctions(String sessionID, int flags)
This method retrieves the list of System functions.
abstract String GetSystemLinkID(String sessionID, String projectID, int systemLink)
This method returns the DSSID of the Link specified by the project and link type.
abstract String GetTransactionReportXML(String sessionID, String transactionReportID)
Returns the XML contains the inputMapping for the transactionReport
abstract String GetUserDICubeInfo(String sessionId, String[] ids, int option)
@return
abstract String GetUserLibrary(String confSessionID, List<EnumDSSXMLLibraryOutputFlag> outputFlags)
This method retrieves the results of all dossiers belonged to specified user.
abstract String GetUserLibrary(String confSessionID)
This method retrieves the results of all dossiers belonged to specified user.
abstract IDSSXMLObjectServer.StringFormatAndErrorData GetUserLibraryEx(String confSessionID, List<EnumDSSXMLLibraryOutputFlag> outputFlags)
This method retrieves the results of all dossiers belonged to specified user.
abstract String GetVLDBInheritedValuesAsJSON(String sessionID, String objectID, int objectType, String messageID, String propertySetID, List<Integer> propertyIDs)
This method is used for getting the inherited value of VLDB property.
abstract String InvokeSourceManipulator(String sessionID, String manipulationXML)
Invoke the source manipulator to perform project merge or metadata deltas in a bulk operation.
abstract boolean IsFeatureEnabled(String sessionID, String featureName)
This method retrieves whether the specified feature is enabled.
abstract String ManipulateUserAnswer(String sessionID, String commandXML, int flag)
This method loads, edits and saves user prompt answers.
abstract String ManipulateUserAnswer(String sessionID, String commandXML)
This method loads, edits and saves user prompt answers.
abstract String MoveObject(String sessionID, String objectID, int objectType, int flags, String newName, String folderDID, boolean solveNameConflict)
This method is used to move an existing object in the metadata.
abstract String MoveObject(String sessionID, String objectID, int objectType, int flags, String newName, String folderDID)
This method is used to move an existing object in the metadata.
abstract String ObjectLock(String sessionID, String command)
This method locks, unlocks and queries object locks in the metadata.
abstract String ParseMetric(String sessionID, String metricID, String mtXML, String tokenStreamXML, String localSymbolFolderXML, int parserActionFlags, int parserOutFlags, String folderID)
This method is used to parse a metric.
abstract String ParseMetric(String sessionID, String messageID, String metricID, String mtXML, String tokenStreamXML, String localSymbolFolderXML, int parserActionFlags, int parserOutFlags, String folderID)
This method is used to parse a metric.
abstract String ParseMetricAndAttribute(String sessionID, String messageID, String objectID, int objectType, String mtXML, String tokenStreamXML, String localSymbolFolderXML, int parserActionFlags, int parserOutFlags, String folderID, String formId)
This method is used to parse a metric, derived metric or derived attribute.
abstract String PropagateToChildren(String sessionID, String id, int objFlags)
abstract String PublishInstance(String sessionID, String messageID, EnumDSSXMLObjectPublishActions publishFlag, List<String> userOrGroupIds)
The publish instance method will handle the publishing, republish, unpublish workflow of an objects instance when published the personal view will contain manipulationsin the definition of the instance.
abstract String PublishObject(String sessionID, String objectID, EnumDSSXMLObjectPublishActions publishFlag, List<String> userOrGroupIds, List<Integer> userOrGroupOperations)
The publish object method will handle the publishing, republish, unpublish workflow of an object in the metadata.
abstract void PurgeSearch(String sessionID, String searchID)
If there are too many searches in a session, it is desirable to purge the searches the session is holding.
abstract String PushNotification(String sessionID, PushNotification pushNotification)
Send Notification
abstract String SaveAsObject(String sessionID, String objectName, int objectType, String folderID, String objectXML, int flags, int xmlFlags)
This method is used to create a new object in the metadata.
abstract void SaveObject(String sessionID, String objectID, int objectType, String objectXML, int flags)
This method is used to save changes to an existing object in the metadata.
abstract void SaveSearchEngineProperties(String sessionID, String autoStartQuickSearch, String indexLocation, String stopwordsXML)
This method is used to save SearchEngineProperties
abstract String Search(String sessionID, String searchObjectXML, boolean useQuickSearch, int searchType, String searchFields)
This method finds a set of DSS objects with the given conditions.
abstract String Search(String sessionID, String searchObjectXML)
This method is deprecated. Use Search(String, String, boolean, int, String) instead
abstract String Search(String sessionID, String searchObjectXML, boolean useQuickSearch, int searchType, String searchFields, int firstObjectIndex)
This method finds a set of DSS objects with the given conditions.
abstract String SearchIndexCommon(String sessionID, int quickSearchCommand, String projeceID, String enabled)
This method is a common method to start/stop SearchEngine,get its properties, start/pause/destroy crawl and so on
abstract String SendEmail(String sessionID, List<String> userOrGroupIds, int notificationType, String emailSubject, String emailBody, String emailHeader, String emailFooter, Map<String, String> extraProperties, boolean emailIsHTML)
Send email
abstract void SetLinkItems(String sessionID, String requestXML)
This method is used to set link items on the Intelligence Server.
abstract void SetProperties(String sessionID, String requestXML, int flags)
This method allows for the manipulation of property sets.
abstract String ShareObject(String sessionID, String messageID, EnumDSSXMLObjectShareActions shareFlag, EnumDSSXMLObjectSharedToUsersFlags sharedToUsersFlag, String[] userOrGroupIds)
This method handles the Share, re-share and unshare workflow
abstract String SynchronousQuickSearch(SynchronousQuickSearch synchronousQuickSearch)
abstract String SynchronousQuickSearch(String sessionID, int quickSearchCmd, String namePattern, int startObject, int count, int searchType, String descriptionPattern, int recursive, int includeManagedObjec, int resolveShortcut, String searchFolders, String ownerIds, String types, String beginCreateTime, String endCreateTime, String beginModifyTime, String endModifyTime, int outputType)
This method retrieves the results of a Synchronous Quick Search

The search results will be returned by this call directly without get search ID first.

abstract IDSSXMLObjectServer.StringFormatAndErrorData SynchronousQuickSearchEx(SynchronousQuickSearch iSynchronousQuickSearch)
abstract String UpdateCubeSecurityFilters(String sessionID, String cubeID, Map<String, String> cubeSecurityFilters)
This method is for partially updating cube's security filters.
abstract void UpdateTheme(String sessionId, String themeID, String defaultPaletteID, String[] paletteIDs, int flag)
Update theme info - add/remove palettes to/from theme; set default palette
abstract String createLocale(String sessionID, String objectName, int localeID, int localeFlag, String folderID, int objectFlag)
This manipulation allows the caller to create a locale object.
abstract String getAllPalettes(String sessionId)
Get all palettes (including system and custom)
abstract String getAndSetExternalSourceInfo(String sessionID, int flags, String sourceID, int sourceType, String userName, String localeDateNumber, Map<String, String> tokenInfo)
Retrieve external source information after setting new token
abstract String getExternalSourceInfo(String sessionID, int flags, String sourceID, int sourceType)
Retrieve external source information
abstract String getRoot(String sessionID, int flags, int level, int blockBegin, int blockCount)
This method retrieves the root of an object hierarchy.
abstract String listTranslations(String sessionID, String listXml)
This manipulation allows user to list any translations at any locales for any keys for multiple objects and their embedded objects.
abstract String updateTranslations(String sessionID, String objectID, int objectType, String updateXml)
This manipulation allows user to add, update, and delete any translations at any locale for one object.

Constants

public static final int DEFAULT_FindObject_blockBegin

Default value for the blockBegin parameter of the FindObject method

Constant Value: 1 (0x00000001)

public static final int DEFAULT_FindObject_blockCount

Default value for the blockCount parameter of the FindObject method

Constant Value: -1 (0xffffffff)

public static final int DEFAULT_FindObject_flags

Default value for the flags parameter of the FindObject method

Constant Value: 0 (0x00000000)

public static final int DEFAULT_FindObject_level

Default value for the level parameter of the FindObject method

Constant Value: -1 (0xffffffff)

public static final int DEFAULT_FindObject_type

Default value for the type parameter of the FindObject method

Constant Value: 8 (0x00000008)

public static final int DEFAULT_GetSearchResults_blockBegin

Default value for the blockBegin parameter of the GetSearchResults method

Constant Value: 1 (0x00000001)

public static final int DEFAULT_GetSearchResults_blockCount

Default value for the blockCount parameter of the GetSearchResults method

Constant Value: -1 (0xffffffff)

public static final int DEFAULT_GetSearchResults_objectFlags

Default value for the objectFlags parameter of the GetSearchResults method

Constant Value: 1 (0x00000001)

public static final int DEFAULT_getRoot_blockBegin

Default value for the blockBegin parameter of the getRoot method

Constant Value: 1 (0x00000001)

public static final int DEFAULT_getRoot_blockCount

Default value for the blockCount parameter of the getRoot method

Constant Value: -1 (0xffffffff)

public static final int DEFAULT_getRoot_flags

Default value for the flags parameter of the getRoot method

Constant Value: 0 (0x00000000)

public static final int DEFAULT_getRoot_level

Default value for the level parameter of the getRoot method

Constant Value: -1 (0xffffffff)

Public Methods

public abstract void ApplyRuntimeSettings (String sessionID)

This method will cause the Intelligence Server to reload it's ServerDef object from the metadata. This is used to propagate changes to the ServerDef to the runtime environment.

Parameters
sessionID A valid session ID from the Intelligence Server.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String CertifyObject (String sessionID, String objectID, int objectType, int certify, int resultFlag)

This method handles the certify and decertify of the object(only support document and report now).

Parameters
sessionID A valid project session id
objectID The ID of the object in the metadata
objectType The type of the object in the metadata EnumDSSXMLObjectFlags, only support document and report type now.
certify 1 for certify object, 0 for decertify object
resultFlag By default is 0 , the result will include every item's execution result, if set as 1, success item will be by-passed, only failure items process result will be return.
Returns
  • Certified: [{"oid":"#Object_ID#","result_code":0,"ctfs":1, "crfid": "#Certifier's ID", "ctfr":"#Certifer's name#","ctfl":"#Certifer's login#","ctft":"#certify time#"}] Not certified: [{ "oid":"#Object_ID#", "result_code":0,"ctfs":0}] Error: [{ "oid":"#Object_ID#", "result_code":"#result code#","er":"#Error_string#"}]
Throws
MSTRWebAPIException Signals an error condition

public abstract String ChangeFeatureStatus (String sessionID, String deltaXML)

This method is used to change the status of features@return

Parameters
sessionID the session id
deltaXML deltaXML
Throws
MSTRWebAPIException

public abstract String ChangeJournalCommon (String sessionID, int type, String extParams)

This method purge/enable/disable change journal.

Parameters
sessionID A valid Session ID
Throws
MSTRWebAPIException Signals an error condition.

public abstract String ChangeJournalSearch (String sessionID, int maxEntries, String searchContentXML)

This method finds a set of DSS objects with the given conditions.

The search results will not be returned in this call. GetChangeJournalSearchResults needs to be called to retrieve the results.

Parameters
sessionID A valid Session ID.
maxEntries The maximum number of change journal entries to retrieve, by default up to the last 100 entries will be retrieved, if the caller passes in 0 all entries associated with the object will be retrieved
searchContentXML searchObjectXML must contain the definition of the search object. This is in XML format and constructed by the Web API to reflect the filter of this search.
Returns
  • The unique ID of the search. This will be passed to GetChangeJournalSearchResults to get the result XML.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String ChangeObjectID (String sessionID, String objectId, int type, String newId)

This method changes DSS ID of the given object.

Parameters
sessionID A valid session id.
objectId The DSS ID of the object to be changed.
type The type of the object to be changed.
newId The new DSS ID of the object.
Throws
MSTRWebAPIException

public abstract String CopyObject (String sessionID, String objectID, int objectType, int flags, String newName, String folderDID)

This method is used to create a copy of an existing object in the metadata.

Parameters
sessionID A valid session ID from an Intelligence Server.
objectID The DSSID of the object to copy.
objectType The type of the object to copy.
flags The object flags.
newName The name of the copied object.
folderDID The target folder where to create the copied object.
Returns
  • object ID of the newly created object.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String CreateFolder (String sessionID, String folderName, String parentFolderID, String folderDesc)

This method creates an empty folder in metadata.

Parameters
sessionID A valid Session ID.
folderName The name of the new folder.
parentFolderID The object ID of the parent folder.
folderDesc Description for the folder.
Returns
  • The ID of the newly created folder.
Throws
MSTRWebAPIException Signals an error condition.

public abstract void DeleteLinkItems (String sessionID, String requestXML)

This method is used to delete link items on the Intelligence Server.

Parameters
sessionID A valid session ID from an Intelligence Server.
requestXML An XML String describing the link items to be deleted.
Throws
MSTRWebAPIException Signals an error condition.

public abstract void DeleteObject (String sessionID, String objectID, int objectType)

This method deletes an object.

Parameters
sessionID A valid Session ID
objectID The object ID of the object to delete.
objectType The type of the object, from EnumDSSXMLObjectTypes. Note that even though the ObjectID uniquely identifies the object, we still need its type to perform this operation.
Throws
MSTRWebAPIException Signals an error condition.

public abstract void DeletePalette (String sessionID, String paletteID)

This method deletes an object.

Parameters
sessionID A valid Session ID
paletteID The palette ID of the object to delete.
Throws
MSTRWebAPIException Signals an error condition.

public abstract void ExecuteBulkSave (String sessionID, String objectXML)

This method is used to submit bulk save.

Parameters
sessionID A valid session ID from an Intelligence Server.
objectXML The object XML representing the latest state of the object.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String FindObject (String sessionID, String messageID, String objectID, int type, int flags, int level, int blockBegin, int blockCount, int propertyFlags, String extParams)

Throws
MSTRWebAPIException

public abstract String FindObject (String sessionID, String objectID, int type, int flags, int level, int blockBegin, int blockCount, int propertyFlags, String extParams, boolean isLeanObject)

Retrieves the representation of an object in XML.

If the type is DssXMLTypeFolder, level, which is not implemented yet, specifies the maximum level of children of the folder to be brought back. 0 level means the folder itself, n means n levels below this folder, and -1 means all levels. By default, the objectType is folder.

Each object contains several bits of information such as browsing information and definition. To optimize the amount of data to bring back, applications can use objectFlags to specify the information that they are interested in.

When blockCount > 0, blockbegin and blockCount will define the subset of the children objects to be returned.

Parameters
sessionID A valid Session ID.
objectID ID of the object.
type Object type listed in the enumeration EnumDSSXMLObjectTypes. [Default=DssXmlTypeFolder]
flags Flags to specify what part of the object information should be put in the returning XML. Flags are also used to specify if the application wants to refresh the object. This value is the bitwise "and" of values take from the enumeration EnumDSSXMLObjectFlags. [Default=0]
level The number of sublevels for which to return children. Only valid when the object is a folder. [Default=-1] (Note: not implemented yet)
blockBegin Starting children object index. Only valid when the object is a folder. [Default=1]
blockCount Maximum number of children objects to return. Only valid when the object is a folder. [Default=-1]
propertyFlags binary OR of EnumDSSXMLPropertyXmlFlags
isLeanObject indicate web needs the lean XML, this is true when getting Device and Transmitter object
Returns
  • The XML of the requested object.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String FindObject (String sessionID, String objectID, int type, int flags, int level, int blockBegin, int blockCount)

Retrieves the representation of an object in XML.

If the type is DssXMLTypeFolder, level, which is not implemented yet, specifies the maximum level of children of the folder to be brought back. 0 level means the folder itself, n means n levels below this folder, and -1 means all levels. By default, the objectType is folder.

Each object contains several bits of information such as browsing information and definition. To optimize the amount of data to bring back, applications can use objectFlags to specify the information that they are interested in.

When blockCount > 0, blockbegin and blockCount will define the subset of the children objects to be returned.

Parameters
sessionID A valid Session ID.
objectID ID of the object.
type Object type listed in the enumeration EnumDSSXMLObjectTypes. [Default=DssXmlTypeFolder]
flags Flags to specify what part of the object information should be put in the returning XML. Flags are also used to specify if the application wants to refresh the object. This value is the bitwise "and" of values take from the enumeration EnumDSSXMLObjectFlags. [Default=0]
level The number of sublevels for which to return children. Only valid when the object is a folder. [Default=-1] (Note: not implemented yet)
blockBegin Starting children object index. Only valid when the object is a folder. [Default=1]
blockCount Maximum number of children objects to return. Only valid when the object is a folder. [Default=-1]
Returns
  • The XML of the requested object.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String FindObject (String sessionID, String objectID, int type, int flags, int level, int blockBegin, int blockCount, int propertyFlags)

Retrieves the representation of an object in XML.

If the type is DssXMLTypeFolder, level, which is not implemented yet, specifies the maximum level of children of the folder to be brought back. 0 level means the folder itself, n means n levels below this folder, and -1 means all levels. By default, the objectType is folder.

Each object contains several bits of information such as browsing information and definition. To optimize the amount of data to bring back, applications can use objectFlags to specify the information that they are interested in.

When blockCount > 0, blockbegin and blockCount will define the subset of the children objects to be returned.

Parameters
sessionID A valid Session ID.
objectID ID of the object.
type Object type listed in the enumeration EnumDSSXMLObjectTypes. [Default=DssXmlTypeFolder]
flags Flags to specify what part of the object information should be put in the returning XML. Flags are also used to specify if the application wants to refresh the object. This value is the bitwise "and" of values take from the enumeration EnumDSSXMLObjectFlags. [Default=0]
level The number of sublevels for which to return children. Only valid when the object is a folder. [Default=-1] (Note: not implemented yet)
blockBegin Starting children object index. Only valid when the object is a folder. [Default=1]
blockCount Maximum number of children objects to return. Only valid when the object is a folder. [Default=-1]
propertyFlags binary OR of EnumDSSXMLPropertyXmlFlags
Returns
  • The XML of the requested object.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String FindObject (String sessionID, String messageID, String objectID, int type, int flags, int level, int blockBegin, int blockCount, int propertyFlags, String extParams, boolean isLeanObject, boolean needThumbnail)

Throws
MSTRWebAPIException

public abstract String FindObject (String sessionID, String objectID, int type, int flags, int level, int blockBegin, int blockCount, int propertyFlags, String extParams)

Retrieves the representation of an object in XML.

If the type is DssXMLTypeFolder, level, which is not implemented yet, specifies the maximum level of children of the folder to be brought back. 0 level means the folder itself, n means n levels below this folder, and -1 means all levels. By default, the objectType is folder.

Each object contains several bits of information such as browsing information and definition. To optimize the amount of data to bring back, applications can use objectFlags to specify the information that they are interested in.

When blockCount > 0, blockbegin and blockCount will define the subset of the children objects to be returned.

Parameters
sessionID A valid Session ID.
objectID ID of the object.
type Object type listed in the enumeration EnumDSSXMLObjectTypes. [Default=DssXmlTypeFolder]
flags Flags to specify what part of the object information should be put in the returning XML. Flags are also used to specify if the application wants to refresh the object. This value is the bitwise "and" of values take from the enumeration EnumDSSXMLObjectFlags. [Default=0]
level The number of sublevels for which to return children. Only valid when the object is a folder. [Default=-1] (Note: not implemented yet)
blockBegin Starting children object index. Only valid when the object is a folder. [Default=1]
blockCount Maximum number of children objects to return. Only valid when the object is a folder. [Default=-1]
propertyFlags binary OR of EnumDSSXMLPropertyXmlFlags
Returns
  • The XML of the requested object.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String FindObject (String sessionID, String messageID, String objectID, int type, int flags, int level, int blockBegin, int blockCount, int propertyFlags, String extParams, boolean isLeanObject)

Throws
MSTRWebAPIException

public abstract String FindObjectByPath (String sessionID, int type, int flags, int level, int blockBegin, int blockCount, String fullPath, int searchFlags)

Retrieves the representation of an object in XML.

If the type is DssXMLTypeFolder, level, which is not implemented yet, specifies the maximum level of children of the folder to be brought back. 0 level means the folder itself, n means n levels below this folder, and -1 means all levels. By default, the objectType is folder.

Each object contains several bits of information such as browsing information and definition. To optimize the amount of data to bring back, applications can use objectFlags to specify the information that they are interested in.

When blockCount > 0, blockbegin and blockCount will define the subset of the children objects to be returned.

Parameters
sessionID A valid Session ID.
type Object type listed in the enumeration EnumDSSXMLObjectTypes. [Default=DssXmlTypeFolder]
flags Flags to specify what part of the object information should be put in the returning XML. Flags are also used to specify if the application wants to refresh the object. This value is the bitwise "and" of values take from the enumeration EnumDSSXMLObjectFlags. [Default=0]
level The number of sublevels for which to return children. Only valid when the object is a folder. [Default=-1] (Note: not implemented yet)
blockBegin Starting children object index. Only valid when the object is a folder. [Default=1]
blockCount Maximum number of children objects to return. Only valid when the object is a folder. [Default=-1]
fullPath String of full path of the target object. If the object is shortcut, it includes the target name of the shortcut.
searchFlags Flags to specify whether the object is shortcut or not.
Returns
  • The XML of the requested object.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String FindObjectByPath (String sessionID, int type, int flags, int level, int blockBegin, int blockCount, String fullPath)

Retrieves the representation of an object in XML.

If the type is DssXMLTypeFolder, level, which is not implemented yet, specifies the maximum level of children of the folder to be brought back. 0 level means the folder itself, n means n levels below this folder, and -1 means all levels. By default, the objectType is folder.

Each object contains several bits of information such as browsing information and definition. To optimize the amount of data to bring back, applications can use objectFlags to specify the information that they are interested in.

When blockCount > 0, blockbegin and blockCount will define the subset of the children objects to be returned.

Parameters
sessionID A valid Session ID.
type Object type listed in the enumeration EnumDSSXMLObjectTypes. [Default=DssXmlTypeFolder]
flags Flags to specify what part of the object information should be put in the returning XML. Flags are also used to specify if the application wants to refresh the object. This value is the bitwise "and" of values take from the enumeration EnumDSSXMLObjectFlags. [Default=0]
level The number of sublevels for which to return children. Only valid when the object is a folder. [Default=-1] (Note: not implemented yet)
blockBegin Starting children object index. Only valid when the object is a folder. [Default=1]
blockCount Maximum number of children objects to return. Only valid when the object is a folder. [Default=-1]
fullPath String of full path of the target object. If the object is shortcut, it includes the target name of the shortcut.
Returns
  • The XML of the requested object.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetChangeJournalSearchResults (String sessionID, String searchID, IntWrapper status, int blockBegin, int blockCount)

This method retrieves the results of a change journal search.

Parameters
sessionID A valid Session ID
searchID The unique id for the search.
status Output Parameter - Search status: a value of type EnumDSSXMLObjectSearchStatus.
blockBegin The index for the first object in the searching result set (incremental fetching). [Default=1]
blockCount The total number of objects to be returned. [Default=-1]
Returns
  • The XML contains the collection of the change journal entries that meet the search criteria
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetConfiguredDSNs (String sessionID)

Returns XML containing a list of Data Source Names configured on the I-Server machine.

Returns
  • XML representing a list of DSNs
Throws
MSTRWebAPIException
MSTRWebAPIException

public abstract String GetCubeSecurityFilters (String sessionID, String userID, String cubeID)

This method get the cube's security filters. if only provide cubeId, the method will return cube's all security filters for provided cube. if provide cubeId and userId, the method will return an cube's security filter for provided cube related to provided user. Explain for backend implement of cube level's security filter: there is no first class object for cube security filter which actually is combined to user level's security filter in MD, the cube security filter expression is pruned form user level's filter by backend. Currently,backend returns cube's security filters through checking userIds in cube's ACL when only provided cubeId.@return

Parameters
sessionID the session id
userID user id
cubeID cube id
Throws
MSTRWebAPIException

public abstract String GetDependencies (String sessionID, String objectID, int objectType, int objectSubType, int detailFlag)

This method retrieves the results of dependency search.

Parameters
sessionID A valid Session ID
objectID The unique id of the object.
objectType The type of the object, from EnumDSSXMLObjectTypes.
objectSubType The type of the object, from EnumDSSXMLObjectSubTypes.
detailFlag Specifying the type of data to return. Should come from EnumDSSXMLNCSInstanceSourceField.Only DssXmlNCSInstanceCountField & DssXmlNCSInstanceDefinitionField are supported. Optional, default value is DssXmlNCSInstanceCountField, and only object counts will be returned.
Returns
  • The XML contains the collection of objects that depend on current objectID.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetDimensionAttributeLock (String sessionID, String dimensionID)

Returns XML containing the System Dimension Attributes that have lock properties specified

Throws
MSTRWebAPIException

public abstract String GetFeatureInfos (String sessionID)

This method retrieves the information of all features.

Parameters
sessionID the session id
Returns
  • the information of all features.
Throws
MSTRWebAPIException

public abstract String GetFilterExpression (String sessionID, String commandXML)

Returns the filter expression that the given filter expression resolves into.

Parameters
sessionID A valid session ID.
commandXML A command XML describing the command to use.
Returns
  • The result of the call.
Throws
MSTRWebAPIException thrown if an error occurs.

public abstract String GetFlexProperties (String sessionID)

Parameters
sessionID A valid Intelligence Server session ID.
Returns
  • Properties governing Flash/flex visualization.
Throws
MSTRWebAPIException
MSTRWebAPIException

public abstract String GetFolderID (String sessionID, int folderName, int requestTimeout)

This method returns the ID of a special folder with specified request timeout.

This method returns the ID of a given folder. With the folder ID, a user can call FindObject to retrieve the objects under this folder. The folderName parameter must be one of the values from EnumDSSXMLFolderNames

.

Parameters
sessionID A valid Session ID
folderName The name of the folder taken from EnumDSSXMLFolderNames.
requestTimeout The request timeout.
Returns
  • An object ID corresponding to a folder.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetFolderID (String sessionID, int folderName)

This method returns the ID of a special folder.

This method returns the ID of a given folder. With the folder ID, a user can call FindObject to retrieve the objects under this folder. The folderName parameter must be one of the values from EnumDSSXMLFolderNames

.

Parameters
sessionID A valid Session ID
folderName The name of the folder taken from EnumDSSXMLFolderNames.
Returns
  • An object ID corresponding to a folder.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetLinkItems (String sessionID, String requestXML, int blockBegin, int blockCount, int flags)

This method is used to retrieve link items from the Intelligence Server.

Parameters
sessionID A valid session ID from an Intelligence Server.
requestXML An XML string describing the information to get.
blockBegin The first item to return in the link item list. Used for incremental fetch.
blockCount The maximum number of items to return in the link item list.
flags The flags to use in the retrieval of the properties. This value should come from EnumDSSXMLPropertyFlags.
Returns
  • An XML String containing the results of the request.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetProperties (String sessionID, String requestXML, int flags)

Gets a property set from the server.

Parameters
sessionID A valid session ID from an Intelligence Server.
requestXML An XML String describing the information to retrieve.
flags A value from EnumDSSXMLPropertyFlags, specifying flags which apply to this operation.
Returns
  • The requested property information, in XML format.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetPublishInfo (String sessionID, String objectID)

This method will provide the publish information for an object, if unpublished an empty response xml will be returned

Parameters
sessionID A valid Session ID
objectID The ID of an object in the metadata
Returns
  • An xml string representing the published object, . In the case that an object is not published an empty xml response will be provided;
Throws
MSTRWebAPIException Signals an error condition

public abstract String GetQuickSearchStatus (String sessionID, int qscmd)

Returns XML containing quick search status.

Returns
  • XML quick search status
Throws
MSTRWebAPIException

public abstract String GetRootExpression (String sessionID, String metricID)

Returns the root expression of the specified metric.

Parameters
sessionID A valid session ID
metricID DSS ID of the metric whose expression is requested
Returns
  • XML representing the root expression of the metric
Throws
MSTRWebAPIException thwon if an error is encountered.

public abstract String GetSearchResults (String sessionID, String searchID, int objectFlags, int blockBegin, int blockCount, StringWrapper searchObject, IntWrapper status)

This method retrieves the results of a search.

When blockCount > 0, blockBegin and blockCount will define a subset of the found objects to returned.

All search results will be returned inside a search folder, which is generated by the Search function in order to store the results. The folder will have no name and - unlike other search objects - a reference to it will be absent beneath the <fct> node of the XML. Additional characteristics are that it will be the only object with an "mf='1'" attribute in its <oi> node, and that the value of the "id" attribute in its <oi> node must be equal to the value of the "rfd" attribute in the <mi> node of the search document.

Even if no results are found in the search, a search folder will still be referenced in the XML returned.

Parameters
sessionID A valid Session ID
searchID The unique id for the search.
objectFlags A value (or sum of values) of type EnumDSSXMLObjectFlags. [Default=DssXmlObjectDefn]
blockBegin The index for the first object in the searching result set (incremental fetching). [Default=1]
blockCount The total number of objects to be returned. [Default=-1]
searchObject Output Parameter - The search object in XML format.
status Output Parameter - Search status: a value of type EnumDSSXMLObjectSearchStatus. DssXmlObjectSearchStatusRunning is returned if the search is still running; DssXmlObjectSearchStatusResultXML is returned if the search is finished and search results are ready.
Returns
  • The XML definition of a folder which contains the dss objects that meet the search criteria (same format as the FindObject output).
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetSearchResults (String sessionID, String searchID, int objectFlags, boolean treeInfo, int blockBegin, int blockCount, StringWrapper searchObject, IntWrapper status, int searchType)

Add a new parameter 'searchType' to send as a flag to backend to stop putting 'folder' objects at top of search results. This method retrieves the results of a search.

When blockCount > 0, blockBegin and blockCount will define a subset of the found objects to returned.

All search results will be returned inside a search folder, which is generated by the Search function in order to store the results. The folder will have no name and - unlike other search objects - a reference to it will be absent beneath the <fct> node of the XML. Additional characteristics are that it will be the only object with an "mf='1'" attribute in its <oi> node, and that the value of the "id" attribute in its <oi> node must be equal to the value of the "rfd" attribute in the <mi> node of the search document.

Even if no results are found in the search, a search folder will still be referenced in the XML returned.

Parameters
sessionID A valid Session ID
searchID The unique id for the search.
objectFlags A value (or sum of values) of type EnumDSSXMLObjectFlags. [Default=DssXmlObjectDefn]
treeInfo A boolean value to indicate whether the results should include the tree structure of the results.
blockBegin The index for the first object in the searching result set (incremental fetching). [Default=1]
blockCount The total number of objects to be returned. [Default=-1]
searchObject Output Parameter - The search object in XML format.
status Output Parameter - Search status: a value of type EnumDSSXMLObjectSearchStatus. DssXmlObjectSearchStatusRunning is returned if the search is still running; DssXmlObjectSearchStatusResultXML is returned if the search is finished and search results are ready.
searchType Search Type: a value of type {@EnumDSSXMLSearchTypes }
Returns
  • The XML definition of a folder which contains the dss objects that meet the search criteria (same format as the FindObject output).
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetSearchResults (String sessionID, String searchID, int objectFlags, boolean treeInfo, int blockBegin, int blockCount, StringWrapper searchObject, IntWrapper status)

This method retrieves the results of a search.

When blockCount > 0, blockBegin and blockCount will define a subset of the found objects to returned.

All search results will be returned inside a search folder, which is generated by the Search function in order to store the results. The folder will have no name and - unlike other search objects - a reference to it will be absent beneath the <fct> node of the XML. Additional characteristics are that it will be the only object with an "mf='1'" attribute in its <oi> node, and that the value of the "id" attribute in its <oi> node must be equal to the value of the "rfd" attribute in the <mi> node of the search document.

Even if no results are found in the search, a search folder will still be referenced in the XML returned.

Parameters
sessionID A valid Session ID
searchID The unique id for the search.
objectFlags A value (or sum of values) of type EnumDSSXMLObjectFlags. [Default=DssXmlObjectDefn]
treeInfo A boolean value to indicate whether the results should include the tree structure of the results.
blockBegin The index for the first object in the searching result set (incremental fetching). [Default=1]
blockCount The total number of objects to be returned. [Default=-1]
searchObject Output Parameter - The search object in XML format.
status Output Parameter - Search status: a value of type EnumDSSXMLObjectSearchStatus. DssXmlObjectSearchStatusRunning is returned if the search is still running; DssXmlObjectSearchStatusResultXML is returned if the search is finished and search results are ready.
Returns
  • The XML definition of a folder which contains the dss objects that meet the search criteria (same format as the FindObject output).
Throws
MSTRWebAPIException Signals an error condition.

public abstract String GetSearchSuggestions (String sessionID, String searchKey, int blockCount, int localeId)

Returns XML containing a list of search suggestions based on the search key provided.

Returns
  • XML representing a list of search suggestions
Throws
MSTRWebAPIException
MSTRWebAPIException

public abstract String GetServerDef (String sessionID)

This method returns the ServerDef which is currently being used by a running server.

Parameters
sessionID A valid session ID from the Intelligence Server.
Returns
  • The ServerDef being used by the server.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract String GetServerDefID (String sessionID)

This method returns the DSSID of the ServerDef which is currently being used by a running server.

Parameters
sessionID A valid session ID from the Intelligence Server.
Returns
  • The DSSID of the ServerDef being used by the server.
Throws
MSTRWebAPIException Thrown if an error occurs.

public abstract byte[] GetSourceManipulatorDelta (String sessionID, String manipulationXML)

Invoke the source manipulator to return a metadata delta package.

Parameters
sessionID A valid session ID.
manipulationXML the XML command to
Returns
  • the result XML string reserved for future use cases. For the time being, it is an empty string.
Throws
MSTRWebAPIException thrown if there is any error

public abstract String GetSystemFunctions (String sessionID, int flags)

This method retrieves the list of System functions.

Parameters
sessionID A valid session ID from the Intelligence Server.
flags the function flags value. It is based on EnumDSSXMLFunctionsFlags
Returns
  • the resultant XML.
Throws
MSTRWebAPIException Thrown if IServer encountered an error.

public abstract String GetSystemLinkID (String sessionID, String projectID, int systemLink)

This method returns the DSSID of the Link specified by the project and link type.

Parameters
sessionID A valid session ID from the Intelligence Server.
projectID The projectID of the project whose link object is queried.
systemLink A valid link type from the enumeration EnumDSSXMLSystemLinks.
Returns
  • DSSID of the Link specified by the project and the link type
Throws
MSTRWebAPIException Thrown if IServer encountered an error.

public abstract String GetTransactionReportXML (String sessionID, String transactionReportID)

Returns the XML contains the inputMapping for the transactionReport

Returns
  • the XML contains the inputMapping for the transactionReport
Throws
MSTRWebAPIException

public abstract String GetUserDICubeInfo (String sessionId, String[] ids, int option)

@return

Throws
MSTRWebAPIException

public abstract String GetUserLibrary (String confSessionID, List<EnumDSSXMLLibraryOutputFlag> outputFlags)

This method retrieves the results of all dossiers belonged to specified user. This method is deprecated. Use GetUserLibraryEx instead.

Parameters
confSessionID The configuration session id
outputFlags Characterize what is contained or filtered out of the library output
Returns
  • The JSON format String of all dossiers
Throws
MSTRWebAPIException

public abstract String GetUserLibrary (String confSessionID)

This method retrieves the results of all dossiers belonged to specified user. This method is deprecated. Use GetUserLibraryEx instead.

Parameters
confSessionID The configuration session id
Returns
  • The JSON format String of all dossiers
Throws
MSTRWebAPIException

public abstract IDSSXMLObjectServer.StringFormatAndErrorData GetUserLibraryEx (String confSessionID, List<EnumDSSXMLLibraryOutputFlag> outputFlags)

This method retrieves the results of all dossiers belonged to specified user. If dossiers for any particular project could not be retrieved, then the Project ID and its exception (reason for failure) is also returned.

Parameters
confSessionID The configuration session id
outputFlags Characterize what is contained or filtered out of the library output, this might be null
Returns
  • The GULData object that holds the JSON format String of all dossiers and the project related errors
Throws
MSTRWebAPIException

public abstract String GetVLDBInheritedValuesAsJSON (String sessionID, String objectID, int objectType, String messageID, String propertySetID, List<Integer> propertyIDs)

This method is used for getting the inherited value of VLDB property. The internal logic can be seen in the doc "VLDB Overall design"

Parameters
sessionID the session id
objectID object id
objectType object type, which can be found in EnumDSSXMLObjectTypes.java
messageID message id
propertySetID the id of VLDB property set, which is a GUID
propertyIDs the id of VLDB property that you want to get value
Returns
  • the json string that contains the VLDB inherited property value
Throws
MSTRWebAPIException

public abstract String InvokeSourceManipulator (String sessionID, String manipulationXML)

Invoke the source manipulator to perform project merge or metadata deltas in a bulk operation. The order of manipulations which appear in the command XML is important and is strictly followed. If one of the manipulations fails it will abort processing and return an error, but there is no attemp to undo any manipulations that is already proecessed.

Parameters
sessionID A valid session ID.
manipulationXML the XML command to
Returns
  • the result XML string reserved for future use cases. For the time being, it is an empty string.
Throws
MSTRWebAPIException thrown if there is any error

public abstract boolean IsFeatureEnabled (String sessionID, String featureName)

This method retrieves whether the specified feature is enabled.

Parameters
sessionID the session id
featureName the name of the specified feature
Returns
  • whether the feature is enabled.
Throws
MSTRWebAPIException

public abstract String ManipulateUserAnswer (String sessionID, String commandXML, int flag)

This method loads, edits and saves user prompt answers.

Parameters
sessionID A valid session ID from the Intelligence Server.
commandXML The body of manipulation command.
flag Flag Whether to return detailed object information. It is based on EnumDSSXMLSourceFlags
Returns
  • the resultant XML.
Throws
MSTRWebAPIException Thrown if IServer encountered an error.

public abstract String ManipulateUserAnswer (String sessionID, String commandXML)

This method loads, edits and saves user prompt answers.

Parameters
sessionID A valid session ID from the Intelligence Server.
Returns
  • the resultant XML.
Throws
MSTRWebAPIException Thrown if IServer encountered an error.

public abstract String MoveObject (String sessionID, String objectID, int objectType, int flags, String newName, String folderDID, boolean solveNameConflict)

This method is used to move an existing object in the metadata.

Parameters
sessionID A valid session ID from an Intelligence Server.
objectID The DSSID of the object to move.
objectType The type of the object to move.
flags The object flags.
newName The name of the moved object.
folderDID The target folder where to create the moved object.
solveNameConflict indicate if we need to resolve name conflicts if there's any.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String MoveObject (String sessionID, String objectID, int objectType, int flags, String newName, String folderDID)

This method is used to move an existing object in the metadata.

Parameters
sessionID A valid session ID from an Intelligence Server.
objectID The DSSID of the object to move.
objectType The type of the object to move.
flags The object flags.
newName The name of the moved object.
folderDID The target folder where to create the moved object.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String ObjectLock (String sessionID, String command)

This method locks, unlocks and queries object locks in the metadata.

Parameters
sessionID A valid session ID from the Intelligence Server.
command the command XML to lock, unlock or query object locks.
Returns
  • the resultant XML for the query object lock command. Returns empty string for lock and unlock object locks.
Throws
MSTRWebAPIException Thrown if IServer encountered an error.

public abstract String ParseMetric (String sessionID, String metricID, String mtXML, String tokenStreamXML, String localSymbolFolderXML, int parserActionFlags, int parserOutFlags, String folderID)

This method is used to parse a metric.

Parameters
mtXML scaled down metric XML
tokenStreamXML token stream XML
localSymbolFolderXML local symbol folder XML
parserActionFlags flags indicating the parse actions from EnumDSSXMLParserActionFlags
parserOutFlags flags from EnumDSSXMLParserOutFlags indicating which part should be returned
folderID DSS ID of the parent folder
Returns
  • scaled down metric and token stream XMLs
Throws
MSTRWebAPIException
MSTRWebAPIException

public abstract String ParseMetric (String sessionID, String messageID, String metricID, String mtXML, String tokenStreamXML, String localSymbolFolderXML, int parserActionFlags, int parserOutFlags, String folderID)

This method is used to parse a metric.

Parameters
mtXML scaled down metric XML
tokenStreamXML token stream XML
localSymbolFolderXML local symbol folder XML
parserActionFlags flags indicating the parse actions from EnumDSSXMLParserActionFlags
parserOutFlags flags from EnumDSSXMLParserOutFlags indicating which part should be returned
folderID DSS ID of the parent folder
Returns
  • scaled down metric and token stream XMLs
Throws
MSTRWebAPIException
MSTRWebAPIException

public abstract String ParseMetricAndAttribute (String sessionID, String messageID, String objectID, int objectType, String mtXML, String tokenStreamXML, String localSymbolFolderXML, int parserActionFlags, int parserOutFlags, String folderID, String formId)

This method is used to parse a metric, derived metric or derived attribute.

Parameters
mtXML scaled down metric XML
tokenStreamXML token stream XML
localSymbolFolderXML local symbol folder XML
parserActionFlags flags indicating the parse actions from EnumDSSXMLParserActionFlags
parserOutFlags flags from EnumDSSXMLParserOutFlags indicating which part should be returned
folderID DSS ID of the parent folder
formId DSS ID of the validating attribute form
Returns
  • scaled down metric and token stream XMLs
Throws
MSTRWebAPIException
MSTRWebAPIException

public abstract String PropagateToChildren (String sessionID, String id, int objFlags)

Throws
MSTRWebAPIException

public abstract String PublishInstance (String sessionID, String messageID, EnumDSSXMLObjectPublishActions publishFlag, List<String> userOrGroupIds)

The publish instance method will handle the publishing, republish, unpublish workflow of an objects instance when published the personal view will contain manipulationsin the definition of the instance.

Parameters
sessionID A valid Session ID
messageID The message ID of an object instance in memory to be published
publishFlag The publish action to be performed EnumDSSXMLObjectPublishActions
userOrGroupIds An array of object ids which will this object will be shared to, these can be user or group object ids
Returns
  • An xml string representing the published object, in the case of unpublish we will be returning an id of 0000000000000000000000000000
Throws
MSTRWebAPIException Signals an error condition

public abstract String PublishObject (String sessionID, String objectID, EnumDSSXMLObjectPublishActions publishFlag, List<String> userOrGroupIds, List<Integer> userOrGroupOperations)

The publish object method will handle the publishing, republish, unpublish workflow of an object in the metadata.

Parameters
sessionID A valid Session ID
objectID The object ID of an object in the metadata to be published
publishFlag The publish action to be performed EnumDSSXMLObjectPublishActions
userOrGroupIds An array of object ids which will this object will be shared to, these can be user or group object ids
Returns
  • An xml string representing the published object, in the case of unpublish we will be returning an id of 0000000000000000000000000000
Throws
MSTRWebAPIException Signals an error condition

public abstract void PurgeSearch (String sessionID, String searchID)

If there are too many searches in a session, it is desirable to purge the searches the session is holding. The responsibility to purge is with the user, because only the user can decide when a search is not useful to him.

Parameters
sessionID A valid Session ID.
searchID If the SearchID is left out, all the searches corresponding to this session are deleted.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String PushNotification (String sessionID, PushNotification pushNotification)

Send Notification

Parameters
sessionID A valid Session ID
pushNotification A object reprensenting the push notification that need to be sent
Returns
  • The returned response from IServer
Throws
MSTRWebAPIException Signals an error condition

public abstract String SaveAsObject (String sessionID, String objectName, int objectType, String folderID, String objectXML, int flags, int xmlFlags)

This method is used to create a new object in the metadata.

Parameters
sessionID A valid session ID from an Intelligence Server.
objectName The name of the new object.
objectType The type of the object to copy.
folderID The target folder where to create the new object.
objectXML The object XML representing the new object.
flags The object flags.
xmlFlags the XML object flag. EnumDSSXMLObjectXMLFlags.Only device/transmitter needs it.
Returns
  • ID of the newly created object.
Throws
MSTRWebAPIException Signals an error condition.

public abstract void SaveObject (String sessionID, String objectID, int objectType, String objectXML, int flags)

This method is used to save changes to an existing object in the metadata.

Parameters
sessionID A valid session ID from an Intelligence Server.
objectID The DSSID of the object to copy.
objectType The type of the object to copy.
objectXML The object XML representing the latest state of the object.
flags The object flags.
Throws
MSTRWebAPIException Signals an error condition.

public abstract void SaveSearchEngineProperties (String sessionID, String autoStartQuickSearch, String indexLocation, String stopwordsXML)

This method is used to save SearchEngineProperties

Parameters
sessionID A valid Session ID
Throws
MSTRWebAPIException Signals an error condition.

public abstract String Search (String sessionID, String searchObjectXML, boolean useQuickSearch, int searchType, String searchFields)

This method finds a set of DSS objects with the given conditions.

The search results will not be returned in this call. GetSearchResults needs to be called to retrieve the results.

Parameters
sessionID A valid Session ID.
searchObjectXML searchObjectXML must contain the definition of the search object. This is in XML format and needs to be constructed by the Web API user. If the user desires to execute a search that is already in the metadata, he needs to extract the object's definition and pass it here.
searchType EnumDSSXMLSearchTypes
searchFields - combination of "name", "description" and "comment" delimited by ","
Returns
  • The unique ID of the search. This will be passed to GetSearchResults to get the result XML.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String Search (String sessionID, String searchObjectXML)

This method is deprecated.
Use Search(String, String, boolean, int, String) instead

This method finds a set of DSS objects with the given conditions.

The search results will not be returned in this call. GetSearchResults needs to be called to retrieve the results.

Parameters
sessionID A valid Session ID.
searchObjectXML searchObjectXML must contain the definition of the search object. This is in XML format and needs to be constructed by the Web API user. If the user desires to execute a search that is already in the metadata, he needs to extract the object's definition and pass it here.
Returns
  • The unique ID of the search. This will be passed to GetSearchResults to get the result XML.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String Search (String sessionID, String searchObjectXML, boolean useQuickSearch, int searchType, String searchFields, int firstObjectIndex)

This method finds a set of DSS objects with the given conditions.

The search results will not be returned in this call. GetSearchResults needs to be called to retrieve the results.

Parameters
sessionID A valid Session ID.
searchObjectXML searchObjectXML must contain the definition of the search object. This is in XML format and needs to be constructed by the Web API user. If the user desires to execute a search that is already in the metadata, he needs to extract the object's definition and pass it here.
searchType EnumDSSXMLSearchTypes
searchFields combination of "name", "description" and "comment" delimited by ","
firstObjectIndex the index to begin searching from
Returns
  • The unique ID of the search. This will be passed to GetSearchResults to get the result XML.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String SearchIndexCommon (String sessionID, int quickSearchCommand, String projeceID, String enabled)

This method is a common method to start/stop SearchEngine,get its properties, start/pause/destroy crawl and so on

Parameters
sessionID A valid Session ID
quickSearchCommand EnumDSSXMLQuickSearchCommands
Throws
MSTRWebAPIException Signals an error condition.

public abstract String SendEmail (String sessionID, List<String> userOrGroupIds, int notificationType, String emailSubject, String emailBody, String emailHeader, String emailFooter, Map<String, String> extraProperties, boolean emailIsHTML)

Send email

Parameters
sessionID A valid Session ID
userOrGroupIds A list of ids (String) which will this object will be shared to, these can be user or user group ids
notificationType User specific flag EnumDSSXMLExternalNotificationType
emailSubject Subject of the email
emailBody Content of the email
emailHeader Header of the email
emailFooter Footer of the email
extraProperties Extra properties of the command
emailIsHTML True is the content of the email is HTML
Returns
  • The returned response from IServer
Throws
MSTRWebAPIException Signals an error condition

public abstract void SetLinkItems (String sessionID, String requestXML)

This method is used to set link items on the Intelligence Server.

Parameters
sessionID A valid session ID from an Intelligence Server.
requestXML An XML String describing the link items to be set.
Throws
MSTRWebAPIException Signals an error condition.

public abstract void SetProperties (String sessionID, String requestXML, int flags)

This method allows for the manipulation of property sets.

Parameters
sessionID A valid session ID from an Intelligence Server.
requestXML An XML String describing the information to change.
flags A value from EnumDSSXMLPropertyFlags, specifying flags which apply to this operation.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String ShareObject (String sessionID, String messageID, EnumDSSXMLObjectShareActions shareFlag, EnumDSSXMLObjectSharedToUsersFlags sharedToUsersFlag, String[] userOrGroupIds)

This method handles the Share, re-share and unshare workflow

Parameters
sessionID A valid Session ID
messageID The message ID of an object to be shared
shareFlag action to be performed EnumDSSXMLObjectShareActions
sharedToUsersFlag User specific flag EnumDSSXMLObjectSharedToUsersFlags
userOrGroupIds An array of object ids which will this object will be shared to, these can be user or group object ids
Returns
  • The id of the newly shared object
Throws
MSTRWebAPIException

public abstract String SynchronousQuickSearch (SynchronousQuickSearch synchronousQuickSearch)

Parameters
synchronousQuickSearch Use a parameter object see SynchronousQuickSearch
Returns
  • The result XML, should be transfer into folder object later.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String SynchronousQuickSearch (String sessionID, int quickSearchCmd, String namePattern, int startObject, int count, int searchType, String descriptionPattern, int recursive, int includeManagedObjec, int resolveShortcut, String searchFolders, String ownerIds, String types, String beginCreateTime, String endCreateTime, String beginModifyTime, String endModifyTime, int outputType)

This method retrieves the results of a Synchronous Quick Search

The search results will be returned by this call directly without get search ID first.

Returns
  • The result XML, should be transfer into folder object later.

    Must have parameters

Throws
MSTRWebAPIException Signals an error condition.

public abstract IDSSXMLObjectServer.StringFormatAndErrorData SynchronousQuickSearchEx (SynchronousQuickSearch iSynchronousQuickSearch)

Throws
MSTRWebAPIException

public abstract String UpdateCubeSecurityFilters (String sessionID, String cubeID, Map<String, String> cubeSecurityFilters)

This method is for partially updating cube's security filters. Explain for backend implement of cube level's security filter: there is no first class object for cube security filter which actually is combined to user level's security filter in MD, the cube security filter expression is pruned form user level's filter by backend. Note that this method requires include the above 10.8 version for IServer due to changed backend.@return

Parameters
sessionID the session id
cubeID cube id
cubeSecurityFilters userId map to filter expression xml
Throws
MSTRWebAPIException

public abstract void UpdateTheme (String sessionId, String themeID, String defaultPaletteID, String[] paletteIDs, int flag)

Update theme info - add/remove palettes to/from theme; set default palette

Throws
MSTRWebAPIException

public abstract String createLocale (String sessionID, String objectName, int localeID, int localeFlag, String folderID, int objectFlag)

This manipulation allows the caller to create a locale object.

Parameters
sessionID A valid Session ID
objectName the name of new locale
localeID locale id
localeFlag It has the effect of adding the new locale to the list of supported metadata and / or data locales in the project. If it is not needed, you can set it to 0;
folderID folder id where the locale is stored
Returns
  • the id of newly created locale
Throws
MSTRWebAPIException

public abstract String getAllPalettes (String sessionId)

Get all palettes (including system and custom)

Parameters
sessionId A valid session id.
Returns
  • String with json format of Palettes List
Throws
MSTRWebAPIException

public abstract String getAndSetExternalSourceInfo (String sessionID, int flags, String sourceID, int sourceType, String userName, String localeDateNumber, Map<String, String> tokenInfo)

Retrieve external source information after setting new token

Parameters
sessionID A valid Session ID
flags XML Command flags
sourceID XML Command srcid
sourceType XML Command srct
userName User name attribute "un" for token info
localeDateNumber Locale date number attribute "lcldn" for token info
tokenInfo Token information map. Example keys: SESSION_ID, SERVER_URL, REFRESH_ID, CLIENT_ID, CLIENT_ID
Returns
  • External source information
Throws
MSTRWebAPIException

public abstract String getExternalSourceInfo (String sessionID, int flags, String sourceID, int sourceType)

Retrieve external source information

Parameters
sessionID A valid Session ID
flags XML Command flags
sourceID XML Command srcid
sourceType XML Command srct
Returns
  • External source information
Throws
MSTRWebAPIException

public abstract String getRoot (String sessionID, int flags, int level, int blockBegin, int blockCount)

This method retrieves the root of an object hierarchy. Based on the sessionID, an application can get the root of the project object hierarchy or configuration object hierarchy.

level specifies the maximum level of children of the folder will be bring back. 0 level means the folder itself, n means n levels below this folder and -1 means all levels.

Each object contains several bits of information such as browsing information, definition. To optimize the amount of data to bring back, application can use flags to specify the information that it is interested in.

When blockCount > 0, blockBegin and blockCount will define a subset of the children objects to returned.

Parameters
sessionID A valid Session ID
flags Flags -EnumDSSXMLObjectFlags- to specify what part of the object information should be put in the returning XML. Flags are also used to specify if the application wants to refresh the object. [Default=0]
level The amount of sublevels for which to return children. Only valid when the object is a folder. Default is -1, meaning all levels.
blockBegin Starting children object index. Only valid when the object is a folder. Default is 1.
blockCount Maximum number of children objects to return. Only valid when the object is a folder. Default is -1, which means all objects.
Returns
  • XML string represents the root folder.
Throws
MSTRWebAPIException Signals an error condition.

public abstract String listTranslations (String sessionID, String listXml)

This manipulation allows user to list any translations at any locales for any keys for multiple objects and their embedded objects.

Parameters
sessionID A valid Session ID
listXml extendable parameter
Returns
  • xml string contains the result of list translations
Throws
MSTRWebAPIException

public abstract String updateTranslations (String sessionID, String objectID, int objectType, String updateXml)

This manipulation allows user to add, update, and delete any translations at any locale for one object.

Parameters
sessionID A valid Session ID
objectID object id
objectType object type
updateXml extendable parameter
Returns
  • the number of added/updated/deleted translations.
Throws
MSTRWebAPIException