Package com.microstrategy.webapi

Interface IDSSXMLDocumentServer

  • public interface IDSSXMLDocumentServer
    This interface provides the functionality for applications to execute and manipulate a document. This includes execution of an XML document by document ID, methods to get an XML document execution result, refresh a document, retrieve document prompt answer, execute dynamic document, and answer an XML document prompt.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String AnswerPrompt​(java.lang.String sessionID, java.lang.String messageID, java.lang.String promptAnswer, int executionFlags, int resultFlags, java.lang.String styleXSL, IntWrapper status)
      Answers a prompt in a document object.
      java.lang.String checkImageExist​(java.lang.String sessionID, java.lang.String messageID, java.lang.String shaValue)
      check whether the image has been stored in MD or in current instance
      void Drill​(java.lang.String sessionID, java.lang.String messageID, java.lang.String drillTransformation, int stateID, int drillOption, StringWrapper drillMsgID)
      This method performs drill operations on a document.
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String styleXSL, StringWrapper messageID, IntWrapper status)
      Execute an XML document by XML document ID.
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, StringWrapper messageID, IntWrapper status)
      Execute an XML document by XML document ID.
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status)  
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey)  
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey, int dossierFlags)  
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey, int dossierFlags, boolean isDossier)  
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo)  
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, java.lang.String subscriptionId)
      Execute an XML document by XML document ID.
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, java.lang.String subscriptionId, java.lang.String bookmarkID)  
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, java.lang.String subscriptionId, java.lang.String bookmarkID, boolean isReport)  
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, java.lang.String subscriptionId, java.lang.String bookmarkID, boolean isReport, boolean manipulationsAutoSavingDisabled)  
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, java.lang.String subscriptionId, java.lang.String bookmarkID, boolean manipulationsAutoSavingDisabled, int evaluationLevel)
      Execute an XML document by XML document ID.
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, java.lang.String subscriptionId, java.lang.String bookmarkID, boolean manipulationsAutoSavingDisabled, int evaluationLevel, java.lang.String[] sharedBookmarkIds)
      Execute an XML document by XML document ID.
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, java.lang.String subscriptionId, java.lang.String bookmarkID, boolean manipulationsAutoSavingDisabled, int evaluationLevel, java.lang.String[] sharedBookmarkIds, int executionFlagsExtension)
      Execute an XML document by XML document ID.
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, java.lang.String subscriptionId, java.lang.String bookmarkID, boolean manipulationsAutoSavingDisabled, int evaluationLevel, java.lang.String[] sharedBookmarkIds, int executionFlagsExtension, java.lang.String applicationId)
      Execute an XML document by XML document ID.
      java.lang.String Execute​(java.lang.String sessionID, java.lang.String documentID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String extParam, java.lang.String styleXSL, java.lang.String delta, StringWrapper messageID, IntWrapper status, java.lang.String topMsgID, java.lang.String nodeKey, int dossierFlags, boolean isDossier, PersonalViewExecutionInfo pvInfo, java.lang.String subscriptionId, java.lang.String bookmarkID, boolean manipulationsAutoSavingDisabled, int evaluationLevel, java.lang.String[] sharedBookmarkIds, int executionFlagsExtension, java.lang.String applicationId, boolean isReport)  
      byte[] ExportDashboard​(java.lang.String sessionID, java.lang.String docID, IntWrapper iwStatus)  
      java.lang.String getBaseGraphProperties​(java.lang.String sessionID, java.lang.String projectID)
      get base graph properties.
      java.lang.String GetCacheInfoJsonResult​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, java.lang.String extendableParameter, IntWrapper iwStatus)
      THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
      java.lang.String GetCacheInfoJsonResult​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, java.lang.String extendableParameter, IntWrapper iwStatus, int resultType)
      THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
      java.lang.String GetDocumentDatasetElements​(java.lang.String sessionID, java.lang.String messageID, java.lang.String datasetID, java.lang.String objectID, int type, java.lang.String filter, int blockBegin, int blockCount)
      Gets the elements XML from dataset.
      java.lang.String GetDocumentDatasetElements​(java.lang.String sessionID, java.lang.String messageID, java.lang.String datasetID, java.lang.String objectID, int type, java.lang.String filter, int flags, int blockBegin, int blockCount)
      Gets the elements XML from dataset.
      java.lang.String GetDocumentDatasetElements​(java.lang.String sessionID, java.lang.String messageID, java.lang.String datasetID, java.lang.String objectID, int type, java.lang.String filter, int flags, int blockBegin, int blockCount, java.lang.String controlKey)  
      java.lang.String GetDocumentDatasetElements​(java.lang.String sessionID, java.lang.String messageID, java.lang.String datasetID, java.lang.String objectID, int type, java.lang.String filter, int flags, int blockBegin, int blockCount, java.lang.String controlKey, java.lang.String templateKey, java.lang.String rawInput)  
      java.lang.String GetDocumentDatasetElements​(java.lang.String sessionID, java.lang.String messageID, java.lang.String datasetID, java.lang.String objectID, int type, java.lang.String filter, int flags, int blockBegin, int blockCount, java.lang.String controlKey, java.lang.String templateKey, java.lang.String rawInput, boolean useBrowseForm)  
      java.lang.String GetDocumentDatasetElements​(java.lang.String sessionID, java.lang.String messageID, java.lang.String datasetID, java.lang.String objectID, int type, java.lang.String filter, int flags, int blockBegin, int blockCount, java.lang.String controlKey, java.lang.String templateKey, java.lang.String rawInput, boolean useBrowseForm, java.lang.String objectCurrentConditionXML)
      Gets the elements XML from dataset.
      java.lang.String getDocumentInstanceShortcutInfo​(java.lang.String sessionID, java.lang.String messageId)
      Gets the shortcut information associated with an instanceId (messageId) of a document
      java.lang.String getDocumentInstanceShortcutInfo​(java.lang.String sessionID, java.lang.String messageId, int dossierShortcutInfoFlag)
      Gets the shortcut information associated with an instanceId (messageId) of a document.
      java.lang.String getDocumentLinksValidationInfo​(java.lang.String sessionID, java.lang.String messageID, int action, java.lang.String extendableParameter)
      get validation info for document level attribute links
      java.lang.String getDocumentShortcutInfo​(java.lang.String sessionID, java.lang.String objectId)
      Gets the shortcut information by the shortcut objectId
      java.lang.String getDocumentShortcutInfo​(java.lang.String sessionID, java.lang.String objectId, int dossierShortcutInfoFlag)
      Gets the shortcut information by the shortcut objectId.
      IDSSXMLObjectServer.StringFormatAndErrorData GetDocumentShortcutInfos​(java.lang.String masterSessionId, java.util.Map<java.lang.String,​ProjectIdAndShortcutIds> projectIdAndShortcutIdsMap, int dossierShortcutInfoFlag)
      Gets shortcut information for multiple shortcut objects across projects.
      java.lang.String getDossierShortcutCacheInfoJsonResult​(java.lang.String sessionID, int cacheType, java.lang.String shortcutId)
      Get the cache info include definition cache and data cache for a dossier shortcut Internal used only
      java.lang.String getDossierShortcutCacheInfoJsonResult​(java.lang.String sessionID, int cacheType, java.lang.String shortcutId, java.lang.Integer resultFlags, java.lang.Integer detailFlags, java.lang.Integer shortcutCacheInfoFlag, java.lang.String bookmarkId)
      Get the cache info include definition cache and data cache for a dossier shortcut Internal used only
      java.lang.String getDossierShortcutCacheInfoJsonResult​(java.lang.String sessionID, int cacheType, java.lang.String shortcutId, java.lang.Integer resultFlags, java.lang.Integer detailFlags, java.lang.String bookmarkId)
      Get the cache info include definition cache and data cache for a dossier shortcut Internal used only
      java.lang.String getDossierShortcutCacheInfoJsonResult​(java.lang.String sessionID, int cacheType, java.lang.String shortcutId, java.lang.String instanceId, java.lang.Integer resultFlags, java.lang.Integer detailFlags, java.lang.Integer shortcutCacheInfoFlag)
      Get the cache info include definition cache and data cache for a dossier shortcut Internal used only
      java.lang.String getDossierShortcutCacheInfoJsonResult​(java.lang.String sessionID, int cacheType, java.lang.String shortcutId, java.lang.String instanceId, java.lang.Integer resultFlags, java.lang.Integer detailFlags, java.lang.Integer shortcutCacheInfoFlag, java.lang.String bookmarkId)
      Get the cache info include definition cache and data cache for a dossier shortcut Internal used only
      java.lang.String getDossierShortcutCacheInfoJsonResult​(java.lang.String sessionID, int cacheType, java.lang.String shortcutId, java.lang.String instanceId, java.lang.Integer resultFlags, java.lang.Integer detailFlags, java.lang.Integer shortcutCacheInfoFlag, java.lang.String bookmarkId, java.lang.String applicationId)
      Get the cache info include definition cache and data cache for a dossier shortcut Internal used only
      byte[] getDossierShortcutCachesInBinary​(java.lang.String sessionID, java.lang.String cacheId)
      Gets the dossier shortcut cache binary by cache id, only support one cache id in 11.1 THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
      java.lang.String GetDossierTocResults​(java.lang.String sessionID, java.lang.String messageID, java.lang.String dossierId, java.lang.String objectType, int resultFlags, IntWrapper status)  
      java.lang.String getElementFromGraph​(java.lang.String sessionID, java.lang.String messageID, java.lang.String nodeKey, java.lang.String sliceID, int x, int y, int width, int height, java.lang.String dpi)
      get elements from graph in document
      java.lang.String getElementFromGraph​(java.lang.String sessionID, java.lang.String messageID, java.lang.String nodeKey, java.lang.String sliceID, int x, int y, java.lang.String dpi)
      get elements from graph in document
      java.lang.String GetExecutionResults​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, java.lang.String styleXSL, int inboxMsgResultFlags, IntWrapper status)
      Returns the execution status for a currently running job.
      java.lang.String GetExecutionResults​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, java.lang.String styleXSL, IntWrapper status)  
      IResultsAsStream GetExecutionResultsAsStream​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int stateID, java.lang.String extendableParameter)  
      IResultsAsStream GetExecutionResultsAsStream​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int stateID, java.lang.String extendableParameter, int inboxMsgResultFlags)
      Obtains the execution results for a document as IResultsAsStream object.
      java.lang.String GetExecutionResultsEx​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int stateID, int inboxMsgResultFlags, java.lang.String extendableParameter, IntWrapper status)
      Obtains the execution results for a document in XML format.
      java.lang.String GetExecutionResultsEx​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int stateID, java.lang.String extendableParameter, IntWrapper status)  
      byte[] GetExecutionResultsInBinary​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, java.lang.Integer mbs, java.lang.String extendableParameter, IntWrapper iwStatus)
      Obtains the results/data of the document in binary format.
      byte[] GetExecutionResultsInBinary​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, java.lang.Integer mbs, java.util.HashMap<java.lang.String,​java.lang.String> mobileProps, java.lang.String extendableParameter, IntWrapper iwStatus)
      Obtains the results/data of the document in binary format.
      byte[] GetExecutionResultsInBinary​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int stateID, java.lang.String extendableParameter, IntWrapper iwStatus)
      Deprecated.
      This method is deprecated.
      byte[][] GetExportFormatData​(java.lang.String sessionID, java.lang.String messageID, int exportFormat, int stateID, java.lang.String extParams, IntWrapper iwStatus)
      Returns formatted output for exporting a document and the cache id.
      byte[] GetFormatData​(java.lang.String sessionID, java.lang.String messageID, int format, int stateID, java.lang.String extendableParameter, IntWrapper iwStatus)
      Returns formatted output for exporting a document.
      int getJobID()
      Get job id of dossier instances / dossier executions
      java.lang.String GetJsonResults​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFalgs, int stateID, java.lang.String extendableParameter, IntWrapper status)  
      java.lang.String GetJsonResults​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFalgs, int stateID, java.lang.String extendableParameter, IntWrapper status, int mode)
      THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT.
      java.lang.Object GetJsonResults​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFalgs, int stateID, java.lang.String extendableParameter, IntWrapper status, int mode, int version)  
      java.lang.String getManifest​(java.lang.String sessionID, java.lang.String messageID, java.lang.String datasetId, java.lang.Boolean useJson)
      get manifest of the document, returns a list of objects used in the document
      java.lang.String getMSTRPredictedFileSize​(java.lang.String sessionID, java.lang.String objectID)
      Gets the predicted MSTR file size of a report or a document
      java.lang.String GetPromptAnswer​(java.lang.String sessionID, java.lang.String messageID)
      Retrieves the prompt answer for the given Message ID.
      java.lang.String GetPromptAnswerEx​(java.lang.String sessionID, java.lang.String messageID, java.lang.String extendableParameter)
      Retrieves the prompt answer for the given Message ID.
      boolean HasPromptAnswer​(java.lang.String sessionID, java.lang.String messageID, StringWrapper promptAnswer)
      Returns whether the document(identified by the given message ID) has prompt answers and retrieves the prompt answer for the given Message ID, if any.
      boolean HasPromptAnswerEx​(java.lang.String sessionID, java.lang.String messageID, StringWrapper promptAnswer, java.lang.String extendableParameter)
      Returns whether the document(identified by the given message ID) has prompt answers and retrieves the prompt answer for the given Message ID, if any.
      java.lang.String ImportAsyncDashboard​(java.lang.String sessionID, java.io.InputStream data, long fileLength, java.lang.String folderID, java.lang.String dashboardName, java.lang.String dashboardDescription, IntWrapper status)  
      java.lang.String ImportDashboard​(java.lang.String sessionID, java.io.InputStream data, long fileLength, java.lang.String folderID, IntWrapper status)  
      java.lang.String importImageToDocument​(java.lang.String sessionID, java.lang.String messageID, java.lang.String binaryID, int blockCount, int blockIndex, int blockSize, java.lang.String treeType, java.lang.String nodeKey, java.lang.String fieldKey, java.lang.String fieldName, java.lang.String imgName, int index, long fileSize, java.lang.String imgID, java.lang.String hashCode, int isEdit, java.io.InputStream data)
      import image to document
      void LoadGraph​(java.lang.String sessionID, java.lang.String messageID, int stateID, java.lang.String nodeKey, int slicedWindowID, java.lang.String windowSetting, int graphImgType, java.lang.String graphProp, IContentConsumer consumer)
      Obtains graph data from backend and steams it to provided content consumer.
      byte[] LoadGraph​(java.lang.String sessionID, java.lang.String messageID, int stateID, java.lang.String templateKey, int graphSliceIdentifier, java.lang.String windowSetting, int graphImgType, java.lang.String graphProp, IntWrapper iwStatus)
      Returns a graph that is contained within a document.
      byte[][] LoadGraphData​(java.lang.String sessionID, java.lang.String messageID, int stateID, java.lang.String templateKey, int graphSliceIdentifier, java.lang.String windowSetting, int graphImgType, java.lang.String graphProp, IntWrapper iwStatus)  
      java.lang.String ReBuildDocument​(java.lang.String sessionID, java.lang.String messageID, int executionFlags, int resultFlags, java.lang.String documentManipulations, int stateID, java.lang.String windowSetting, java.lang.String extParam, StringWrapper msgID, IntWrapper status)
      This method will submit a set of manipulations on a document.
      java.lang.String ReBuildDocument​(java.lang.String sessionID, java.lang.String messageID, int executionFlags, int resultFlags, java.lang.String documentManipulations, int stateID, java.lang.String windowSetting, java.lang.String extParam, StringWrapper msgID, IntWrapper status, int executionFlagsExtension)
      This method will submit a set of manipulations on a document.
      java.lang.String Refresh​(java.lang.String sessionID, java.lang.String messageID, int stateID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String deltaXML, java.lang.String extParam, java.lang.String styleXSL, IntWrapper status)  
      java.lang.String Refresh​(java.lang.String sessionID, java.lang.String messageID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String styleXSL, IntWrapper status)
      Refreshs an already executed document.
      java.lang.String Refresh​(java.lang.String sessionID, java.lang.String messageID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String deltaXML, java.lang.String styleXSL, IntWrapper status)
      Refreshs an already executed document.
      java.lang.String Refresh​(java.lang.String sessionID, java.lang.String messageID, int executionFlags, int resultFlags, java.lang.String promptAnswer, java.lang.String deltaXML, java.lang.String extParam, java.lang.String styleXSL, IntWrapper status)
      Refreshs an already executed document.
      void ResumeImportAsyncDashboard​(java.lang.String sessionID, java.lang.String messageID, java.lang.String dashboardName)  
      java.lang.String SaveAs​(java.lang.String sessionID, java.lang.String messageID, java.lang.String folderID, java.lang.String documentName, java.lang.String documentDesc, int flags, int stateID)
      Saves the given document instance to metadata.
      java.lang.String SaveAs​(java.lang.String sessionID, java.lang.String messageID, java.lang.String folderID, java.lang.String documentName, java.lang.String documentDesc, int flags, int stateID, java.lang.String reportSaveAsOptions)
      Saves the given document instance to metadata.
      java.lang.String SaveAs​(java.lang.String sessionID, java.lang.String messageID, java.lang.String folderID, java.lang.String documentName, java.lang.String documentDesc, int flags, int stateID, java.lang.String reportSaveAsOptions, IntWrapper status)  
      java.lang.String SaveAs​(java.lang.String sessionID, java.lang.String messageID, java.lang.String folderID, java.lang.String documentName, java.lang.String documentDesc, int flags, int stateID, java.lang.String reportSaveAsOptions, IntWrapper status, int requestTimeout)
      Saves the given document instance to metadata.
      java.lang.String SaveAsReport​(java.lang.String sessionId, java.lang.String messageId, java.lang.String folderId, java.lang.String reportName, java.lang.String reportDescription, int flags, int stateId, IntWrapper status, int requestTimeout)
      Saves the given document instance to metadata.
      java.lang.String SaveAsSegment​(java.lang.String sessionID, java.lang.String messageID, java.lang.String folderID, java.lang.String segmentName, java.lang.String segmentDesc, int flags, java.lang.String nodeKey)
      Create a segment from a document instance
      java.lang.String SaveAsTheme​(java.lang.String sessionID, java.lang.String messageID, java.lang.String folderID, java.lang.String themeName, java.lang.String themeDesc, int flags, int stateID)
      Saves the given theme instance to metadata.
      java.lang.String SaveDerivedElements​(java.lang.String sessionID, java.lang.String messageID, java.lang.String unitKey, java.lang.String attId, java.lang.String folderId, java.lang.String name, java.lang.String description, boolean overwrite, IntWrapper status)  
      void SendBinaryData​(java.lang.String sessionID, java.lang.String messageID, int format, int stateID, java.lang.String extendableParameter, IContentConsumer consumer)  
      void SendExecutionResultsInBinary​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, java.lang.Integer mbs, java.lang.String extendableParameter, IntWrapper iwStatus, IContentConsumer consumer)
      Obtains the results/data of the document in binary format.
      void SendExecutionResultsInBinary​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int detailFlags, int stateID, java.lang.Integer mbs, java.util.HashMap<java.lang.String,​java.lang.String> mobileProps, java.lang.String extendableParameter, IntWrapper iwStatus, IContentConsumer consumer)
      Obtains the results/data of the document in binary format.
      void SendExecutionResultsInBinary​(java.lang.String sessionID, java.lang.String messageID, int resultFlags, int stateID, java.lang.String extendableParameter, IntWrapper iwStatus, IContentConsumer consumer)
      Deprecated.
      This method is deprecated.

    • Field Detail

      • DEFAULT_AnswerPrompt_executionFlags

        static final int DEFAULT_AnswerPrompt_executionFlags
        Default executionFlags parameter for AnswerPrompt method
        See Also:
        Constant Field Values

      • DEFAULT_AnswerPrompt_resultFlags

        static final int DEFAULT_AnswerPrompt_resultFlags
        Default resultFlags parameter for AnswerPrompt method
        See Also:
        Constant Field Values

      • DEFAULT_AnswerPrompt_styleXSL

        static final java.lang.String DEFAULT_AnswerPrompt_styleXSL
        Default styleXSL parameter for AnswerPrompt method
        See Also:
        Constant Field Values

      • DEFAULT_Execute_executionFlags

        static final int DEFAULT_Execute_executionFlags
        Default executionFlags parameter for Execute method
        See Also:
        Constant Field Values

      • DEFAULT_Execute_resultFlags

        static final int DEFAULT_Execute_resultFlags
        Default resultFlags parameter for Execute method
        See Also:
        Constant Field Values

      • DEFAULT_Execute_promptAnswer

        static final java.lang.String DEFAULT_Execute_promptAnswer
        Default promptAnswer parameter for Execute method
        See Also:
        Constant Field Values

      • DEFAULT_Execute_styleXSL

        static final java.lang.String DEFAULT_Execute_styleXSL
        Default styleXSL parameter for Execute method
        See Also:
        Constant Field Values

      • DEFAULT_ExecuteDynamicDoc_executionFlags

        static final int DEFAULT_ExecuteDynamicDoc_executionFlags
        Default executionFlags parameter for ExecuteDynamicDoc method
        See Also:
        Constant Field Values

      • DEFAULT_ExecuteDynamicDoc_resultFlags

        static final int DEFAULT_ExecuteDynamicDoc_resultFlags
        Default resultFlags parameter for ExecuteDynamicDoc method
        See Also:
        Constant Field Values

      • DEFAULT_ExecuteDynamicDoc_promptAnswer

        static final java.lang.String DEFAULT_ExecuteDynamicDoc_promptAnswer
        Default promptAnswer parameter for ExecuteDynamicDoc method
        See Also:
        Constant Field Values

      • DEFAULT_ExecuteDynamicDoc_contentSetting

        static final java.lang.String DEFAULT_ExecuteDynamicDoc_contentSetting
        Default contentSetting parameter for ExecuteDynamicDoc method
        See Also:
        Constant Field Values

      • DEFAULT_ExecuteDynamicDoc_styleXSL

        static final java.lang.String DEFAULT_ExecuteDynamicDoc_styleXSL
        Default styleXSL parameter for ExecuteDynamicDoc method
        See Also:
        Constant Field Values

      • DEFAULT_GetExecutionResults_resultFlags

        static final int DEFAULT_GetExecutionResults_resultFlags
        Default resultFlags parameter for GetExecutionResults method
        See Also:
        Constant Field Values

      • DEFAULT_GetExecutionResults_styleXSL

        static final java.lang.String DEFAULT_GetExecutionResults_styleXSL
        Default styleXSL parameter for GetExecutionResults method
        See Also:
        Constant Field Values

      • DEFAULT_Refresh_executionFlags

        static final int DEFAULT_Refresh_executionFlags
        Default executionFlags parameter for Refresh method
        See Also:
        Constant Field Values

      • DEFAULT_Refresh_resultFlags

        static final int DEFAULT_Refresh_resultFlags
        Default resultFlags parameter for Refresh method
        See Also:
        Constant Field Values

      • DEFAULT_Refresh_promptAnswer

        static final java.lang.String DEFAULT_Refresh_promptAnswer
        Default promptAnswer parameter for Refresh method
        See Also:
        Constant Field Values

      • DEFAULT_Refresh_styleXSL

        static final java.lang.String DEFAULT_Refresh_styleXSL
        Default styleXSL parameter for Refresh method
        See Also:
        Constant Field Values

      • MOBILE_PROPERTY_ENCRYPT

        static final java.lang.String MOBILE_PROPERTY_ENCRYPT
        See Also:
        Constant Field Values

      • MOBILE_PROPERTY_DEVICE_TOKEN

        static final java.lang.String MOBILE_PROPERTY_DEVICE_TOKEN
        See Also:
        Constant Field Values

      • MOBILE_PROPERTY_APP_ID

        static final java.lang.String MOBILE_PROPERTY_APP_ID
        See Also:
        Constant Field Values

      • MOBILE_PROPERTY_TOKEN_TYPE

        static final java.lang.String MOBILE_PROPERTY_TOKEN_TYPE
        See Also:
        Constant Field Values

    • Method Detail

      • getJobID

        int getJobID()
        Get job id of dossier instances / dossier executions
        Returns:
        Job id of dossier instances / dossier executions

      • AnswerPrompt

        java.lang.String AnswerPrompt​(java.lang.String sessionID,
                              java.lang.String messageID,
                              java.lang.String promptAnswer,
                              int executionFlags,
                              int resultFlags,
                              java.lang.String styleXSL,
                              IntWrapper status)
                       throws MSTRWebAPIException
        Answers a prompt in a document object.

        This function applies the promptAnswer to the XML document prompt and continues the XML document execution. The caller should call GetExecutionResults to retrieve the result of the execution.

        There may be more prompts to answer after the promptAnswer is applied to the XML document, due to either the inclusion of prompts in the prompt answer, or the incomplete answering of the prompts in this document. When calling GetExecutionResults, the status DssXmlStatusPromptXML denotes the above, and the new promptXML is returned in the result of that function.

        See the Execute method for more on document execution, and execution status.

        Parameters:
        sessionID - A valid Session ID.
        messageID - The message ID of the instance of the document.
        promptAnswer - XML that answers the prompt question XML.
        executionFlags - EnumDSSXMLDocExecutionFlags - Flags to use when executing the document. [Default=0]
        resultFlags - EnumDSSXMLDocResultFlags - Flags relating to the result of the execution. [Default=0]
        styleXSL - XSL for the document style. [Default=""]
        status - Output Parameter - IntWrapper containing EnumDSSXMLStatus - Holds the status of the execution after answering the prompt.
        Returns:
        XML String that represents results, if the report is ready. If not, it will be null.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • Drill

        void Drill​(java.lang.String sessionID,
           java.lang.String messageID,
           java.lang.String drillTransformation,
           int stateID,
           int drillOption,
           StringWrapper drillMsgID)
    throws MSTRWebAPIException
        This method performs drill operations on a document.

        This function performs a drill action defined by the drillTransformation parameter. The drillTransformation is with respect to the document results that the user is seeing right now. These could be the end result of a few manipulations such as pivot, sort and group-by on the original document Instance. These document manipulations are recorded in the Inbox and the drilling is done on a Document Instance that has all these transformations applied to it. The input messageID indicates the document you want to drill on. A new message needs to be created for the drill result and the ID for this new message will be returned. The user can specify if the drill needs to be performed within the document or out side of the document. If the user requrest the drill to be performed within the document then this message ID resulting from the drill commad is a document message ID and if the user requests the drill to be performed outside the document the resulting message ID is a report message ID. The input drillOption will specify if the user needs to drill within or out of the document. This function will never return a result directly. GetExecutionResults has to be called with the new message ID, to retrieve the drill results.

        Refer to the remarks of IDSSXMLDocumentServer.GetExecutionResults for details of the stateID parameter. The drill will be applied on the report state identified by the stateID when it is present. By default, the drill will be on the final state of the report.

        Parameters:
        sessionID - A valid Session ID.
        messageID - Message ID corresponding to the document to be drilled.
        drillTransformation - XML that defines the drill action
        stateID - An ID to identify the report manipulation state. [Default=-1]
        drillMsgID - Return Parameter - The message ID resulting from the drill operation.
        drillOption - Return Parameter - The message ID resulting from the drill operation.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 9.0.0

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String styleXSL,
                         StringWrapper messageID,
                         IntWrapper status)
                  throws MSTRWebAPIException
        Execute an XML document by XML document ID.

        ExecutionFlag is a value from the enumeration EnumDSSXMLDocExecutionFlags. You need to set it to DssXmlDocExecutionHTML to get the HTML returned. If an error happens while the XML document is being executed, an error message will be returned in the executionResults. Otherwise an inbox message ID will be returned in the messageID output parameter. You need to use GetExecutionResults to retrieve the results.

        With promptAnswer , the caller can provide answers to prompts in the document before running it.

        The status of the function call indicates the execution status. See the flags section for details.

        Parameters:
        sessionID - A valid session ID.
        documentID - The object ID of the document to execute.
        executionFlags - specifies options for the execution of the document. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlags. [Default=0]
        resultFlags - Flags to apply to the result of the execution. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocResultFlags. [Default=0]
        promptAnswer - Pre-answer for prompting. This is used if it is known that the document has a prompt in it, and the answer XML is already known. [Default=""]
        styleXSL - XSL for the document style. [Default=""]
        messageID - Output Parameter - The job ID of the request. This is needed when checking the status of the document execution.
        status - Output Parameter The current status of the request. Value comes from EnumDSSXMLStatus.
        Returns:
        If the document is ready upon returning, this will be an XML String representing the document. If not, this will be null.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         StringWrapper messageID,
                         IntWrapper status)
                  throws MSTRWebAPIException
        Execute an XML document by XML document ID.

        ExecutionFlag is a value from the enumeration EnumDSSXMLDocExecutionFlags. You need to set it to DssXmlDocExecutionHTML to get the HTML returned. If an error happens while the XML document is being executed, an error message will be returned in the executionResults. Otherwise an inbox message ID will be returned in the messageID output parameter. You need to use GetExecutionResults to retrieve the results.

        With promptAnswer , the caller can provide answers to prompts in the document before running it.

        The status of the function call indicates the execution status. See the flags section for details.

        Parameters:
        sessionID - A valid session ID.
        documentID - The object ID of the document to execute.
        executionFlags - specifies options for the execution of the document. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlags. [Default=0]
        resultFlags - Flags to apply to the result of the execution. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocResultFlags. [Default=0]
        promptAnswer - Pre-answer for prompting. This is used if it is known that the document has a prompt in it, and the answer XML is already known. [Default=""]
        extParam - indicates any applicable extendable parameters
        styleXSL - XSL for the document style. [Default=""]
        messageID - Output Parameter - The job ID of the request. This is needed when checking the status of the document execution.
        status - Output Parameter The current status of the request. Value comes from EnumDSSXMLStatus.
        Returns:
        If the document is ready upon returning, this will be an XML String representing the document. If not, this will be null.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.0

      • GetExecutionResults

        java.lang.String GetExecutionResults​(java.lang.String sessionID,
                                     java.lang.String messageID,
                                     int resultFlags,
                                     java.lang.String styleXSL,
                                     int inboxMsgResultFlags,
                                     IntWrapper status)
                              throws MSTRWebAPIException
        Returns the execution status for a currently running job. Will also return the XML corresponding to the document if it is ready.

        This method is used to pull the document execution results with the message ID returned by Execute method. This is usually put in a loop until one of the following happens:

        • status = EnumDSSXMLStatus.DssXmlStatusErrMsgXML
        • status = EnumDSSXMLStatus.DssXmlStatusResult
        • status = EnumDSSXMLStatus.DssXmlStatusPromptXML
        You should put a delay in the loop to prevent the server being pulled too frequently.

        Parameters:
        sessionID - A valid Session ID.
        messageID - A valid message/job ID.
        resultFlags - EnumDSSXMLResultFlags - Describe how result is to be presented. [Default=0]
        styleXSL - XSL for the document style. [Default=""]
        inboxMsgResultFlags - For inbox message, value from EnumDSSXMLInboxMsgResultFlags
        status - - EnumDSSXMLStatus - Contains the current status of the document.
        Returns:
        XML String that corresponds to the document XML, if the document is ready.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • GetExecutionResults

        java.lang.String GetExecutionResults​(java.lang.String sessionID,
                                     java.lang.String messageID,
                                     int resultFlags,
                                     java.lang.String styleXSL,
                                     IntWrapper status)
                              throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • GetPromptAnswer

        java.lang.String GetPromptAnswer​(java.lang.String sessionID,
                                 java.lang.String messageID)
                          throws MSTRWebAPIException
        Retrieves the prompt answer for the given Message ID.

        If the report identified by the given message ID contains no prompt or the prompt has not been answered, this method will return an empty string. Otherwise, the latest prompt answered will be returned.

        Parameters:
        sessionID - A valid Session ID.
        messageID - A valid message/job ID.
        Returns:
        XML corresponding to the prompt answer.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • GetPromptAnswerEx

        java.lang.String GetPromptAnswerEx​(java.lang.String sessionID,
                                   java.lang.String messageID,
                                   java.lang.String extendableParameter)
                            throws MSTRWebAPIException
        Retrieves the prompt answer for the given Message ID.

        If the report identified by the given message ID contains no prompt or the prompt has not been answered, this method will return an empty string. Otherwise, the latest prompt answered will be returned.

        Parameters:
        sessionID - A valid Session ID.
        messageID - A valid message/job ID.
        extendableParameter - The extendable parameter value.
        Returns:
        XML corresponding to the prompt answer.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.2

      • HasPromptAnswer

        boolean HasPromptAnswer​(java.lang.String sessionID,
                        java.lang.String messageID,
                        StringWrapper promptAnswer)
                 throws MSTRWebAPIException
        Returns whether the document(identified by the given message ID) has prompt answers and retrieves the prompt answer for the given Message ID, if any.

        If the document identified by the given message ID contains no prompt or if the prompt has not been answered, this method will return false and will also return return an null string inside promptAnswer. Otherwise, the latest prompt answered will be returned.

        Parameters:
        sessionID - A valid Session ID.
        messageID - A valid message/job ID.
        promptAnswer - The prompt answer will be returned in this variable.
        Returns:
        boolean indicating whether the document is prompted or not. XML corresponding to the prompt answer as a function argument.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • HasPromptAnswerEx

        boolean HasPromptAnswerEx​(java.lang.String sessionID,
                          java.lang.String messageID,
                          StringWrapper promptAnswer,
                          java.lang.String extendableParameter)
                   throws MSTRWebAPIException
        Returns whether the document(identified by the given message ID) has prompt answers and retrieves the prompt answer for the given Message ID, if any.

        If the document identified by the given message ID contains no prompt or if the prompt has not been answered, this method will return false and will also return return an null string inside promptAnswer. Otherwise, the latest prompt answered will be returned.

        Parameters:
        sessionID - A valid Session ID.
        messageID - A valid message/job ID.
        promptAnswer - The prompt answer will be returned in this variable.
        extendableParameter - The extendable parameter value.
        Returns:
        boolean indicating whether the document is prompted or not. XML corresponding to the prompt answer as a function argument.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.2

      • Refresh

        java.lang.String Refresh​(java.lang.String sessionID,
                         java.lang.String messageID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String styleXSL,
                         IntWrapper status)
                  throws MSTRWebAPIException
        Refreshs an already executed document.
        Parameters:
        sessionID - A valid Session ID.
        messageID - The message/job ID of the execution instance to refresh
        executionFlags - EnumDSSXMLDocExecutionFlags - Flags used in the execution of the document. [Default=0]
        resultFlags - EnumDSSXMLDocResultFlags - Flags used in the manipulation of the result. [Default=0]
        promptAnswer - Pre-answer for any prompts in the document. [Default=0]
        styleXSL - XSL for the document style. [Default=0]
        status - Output Parameter - EnumDSSXMLStatus - After execution, will contain the current status of the submitted request.
        Returns:
        XML String corresponding to the result XML, if the status is that the document is finished executing.

        This method re-executes the document identified by the given message ID. This does not mean re-execute the document against the warehouse. It is up to the server to decide whether a cache should be used. If the server hits a cache, this method will return the cached data.

        Throws:
        MSTRWebAPIException - Signals an error condition.

      • Refresh

        java.lang.String Refresh​(java.lang.String sessionID,
                         java.lang.String messageID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String deltaXML,
                         java.lang.String styleXSL,
                         IntWrapper status)
                  throws MSTRWebAPIException
        Refreshs an already executed document.
        Parameters:
        sessionID - A valid Session ID.
        messageID - The message/job ID of the execution instance to refresh
        executionFlags - EnumDSSXMLDocExecutionFlags - Flags used in the execution of the document. [Default=0]
        resultFlags - EnumDSSXMLDocResultFlags - Flags used in the manipulation of the result. [Default=0]
        promptAnswer - Pre-answer for any prompts in the document. [Default=0]
        deltaXML - The delta xml representing the changes that need to be applied while refreshing
        styleXSL - XSL for the document style. [Default=0]
        status - Output Parameter - EnumDSSXMLStatus - After execution, will contain the current status of the submitted request.
        Returns:
        XML String corresponding to the result XML, if the status is that the document is finished executing.

        This method re-executes the document identified by the given message ID. This does not mean re-execute the document against the warehouse. It is up to the server to decide whether a cache should be used. If the server hits a cache, this method will return the cached data.

        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.0

      • Refresh

        java.lang.String Refresh​(java.lang.String sessionID,
                         java.lang.String messageID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String deltaXML,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         IntWrapper status)
                  throws MSTRWebAPIException
        Refreshs an already executed document.
        Parameters:
        sessionID - A valid Session ID.
        messageID - The message/job ID of the execution instance to refresh
        executionFlags - EnumDSSXMLDocExecutionFlags - Flags used in the execution of the document. [Default=0]
        resultFlags - EnumDSSXMLDocResultFlags - Flags used in the manipulation of the result. [Default=0]
        promptAnswer - Pre-answer for any prompts in the document. [Default=0]
        deltaXML - The delta xml representing the changes that need to be applied while refreshing
        extParam - An XML string of additional information that will modify the result of the rebuild call.
        styleXSL - XSL for the document style. [Default=0]
        status - Output Parameter - EnumDSSXMLStatus - After execution, will contain the current status of the submitted request.
        Returns:
        XML String corresponding to the result XML, if the status is that the document is finished executing.

        This method re-executes the document identified by the given message ID. This does not mean re-execute the document against the warehouse. It is up to the server to decide whether a cache should be used. If the server hits a cache, this method will return the cached data.

        Throws:
        MSTRWebAPIException - Signals an error condition.

      • ReBuildDocument

        java.lang.String ReBuildDocument​(java.lang.String sessionID,
                                 java.lang.String messageID,
                                 int executionFlags,
                                 int resultFlags,
                                 java.lang.String documentManipulations,
                                 int stateID,
                                 java.lang.String windowSetting,
                                 java.lang.String extParam,
                                 StringWrapper msgID,
                                 IntWrapper status)
                          throws MSTRWebAPIException
        This method will submit a set of manipulations on a document.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        executionFlags - The execution flags to use, from EnumDSSXMLExecutionFlags.
        resultFlags - The result flags to use, from EnumDSSXMLResultFlags.
        documentManipulations - An XML string describing the manipulations to be done.
        stateID - The state ID of the document instance being manipulated.
        windowSetting - The window setting for the new document instance.
        extParam - An XML string of additional information that will modify the result of the rebuild call.
        msgID - A StringWrapper object which will contain the message ID after this operation. Note that if the message ID is the same after this operation as it was before, then the results can be obtained by incrementing the state ID.
        status - The status of the job on the server after calling this method, from EnumDSSXMLStatus.
        Returns:
        The result of this operation. Note that generally it is necessary to call GetExecutionResults to get the resulting document.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 8.0.0

      • ReBuildDocument

        java.lang.String ReBuildDocument​(java.lang.String sessionID,
                                 java.lang.String messageID,
                                 int executionFlags,
                                 int resultFlags,
                                 java.lang.String documentManipulations,
                                 int stateID,
                                 java.lang.String windowSetting,
                                 java.lang.String extParam,
                                 StringWrapper msgID,
                                 IntWrapper status,
                                 int executionFlagsExtension)
                          throws MSTRWebAPIException
        This method will submit a set of manipulations on a document.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        executionFlags - The execution flags to use, from EnumDSSXMLExecutionFlags.
        resultFlags - The result flags to use, from EnumDSSXMLResultFlags.
        documentManipulations - An XML string describing the manipulations to be done.
        stateID - The state ID of the document instance being manipulated.
        windowSetting - The window setting for the new document instance.
        extParam - An XML string of additional information that will modify the result of the rebuild call.
        msgID - A StringWrapper object which will contain the message ID after this operation. Note that if the message ID is the same after this operation as it was before, then the results can be obtained by incrementing the state ID.
        status - The status of the job on the server after calling this method, from EnumDSSXMLStatus.
        executionFlagsExtension - specifies options for the execution flags extension of the document. Values must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlagsExtension [Default=0]
        Returns:
        The result of this operation. Note that generally it is necessary to call GetExecutionResults to get the resulting document.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 11.3

      • SaveAs

        java.lang.String SaveAs​(java.lang.String sessionID,
                        java.lang.String messageID,
                        java.lang.String folderID,
                        java.lang.String documentName,
                        java.lang.String documentDesc,
                        int flags,
                        int stateID)
                 throws MSTRWebAPIException
        Saves the given document instance to metadata.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        folderID - The ID of the folder to save the document to.
        documentName - The name to save the document as.
        documentDesc - The description of the document.
        flags - Flags which modify the behavior of the call, from EnumDSSXMLDocSaveAsFlags.
        stateID - The ID of the state of the document to save.
        Returns:
        Object ID of the new documented created.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 8.0.0

      • SaveAs

        java.lang.String SaveAs​(java.lang.String sessionID,
                        java.lang.String messageID,
                        java.lang.String folderID,
                        java.lang.String documentName,
                        java.lang.String documentDesc,
                        int flags,
                        int stateID,
                        java.lang.String reportSaveAsOptions)
                 throws MSTRWebAPIException
        Saves the given document instance to metadata.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        folderID - The ID of the folder to save the document to.
        documentName - The name to save the document as.
        documentDesc - The description of the document.
        flags - Flags which modify the behavior of the call, from EnumDSSXMLDocSaveAsFlags.
        stateID - The ID of the state of the document to save.
        reportSaveAsOptions - The xml delta of the report SaveAs options for datasets within document.
        Returns:
        Object ID of the new document created.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 8.0.0

      • SaveAs

        java.lang.String SaveAs​(java.lang.String sessionID,
                        java.lang.String messageID,
                        java.lang.String folderID,
                        java.lang.String documentName,
                        java.lang.String documentDesc,
                        int flags,
                        int stateID,
                        java.lang.String reportSaveAsOptions,
                        IntWrapper status)
                 throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • SaveAsReport

        java.lang.String SaveAsReport​(java.lang.String sessionId,
                              java.lang.String messageId,
                              java.lang.String folderId,
                              java.lang.String reportName,
                              java.lang.String reportDescription,
                              int flags,
                              int stateId,
                              IntWrapper status,
                              int requestTimeout)
                       throws MSTRWebAPIException
        Saves the given document instance to metadata.
        Parameters:
        sessionId - A valid session ID.
        messageId - The message ID of the document instance.
        folderId - The ID of the folder to save the document to.
        reportName - The name to save the report as.
        reportDescription - The description of the report.
        flags - Flags which modify the behavior of the call, from EnumDSSXMLDocSaveAsFlags.
        stateId - The ID of the state of the report to save.
        status - - EnumDSSXMLStatus - Contains the current status of the report.
        requestTimeout - Timeout in milliseconds for the xml command
        Returns:
        Object ID of the new report created.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 11.3.5

      • SaveAs

        java.lang.String SaveAs​(java.lang.String sessionID,
                        java.lang.String messageID,
                        java.lang.String folderID,
                        java.lang.String documentName,
                        java.lang.String documentDesc,
                        int flags,
                        int stateID,
                        java.lang.String reportSaveAsOptions,
                        IntWrapper status,
                        int requestTimeout)
                 throws MSTRWebAPIException
        Saves the given document instance to metadata.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        folderID - The ID of the folder to save the document to.
        documentName - The name to save the document as.
        documentDesc - The description of the document.
        flags - Flags which modify the behavior of the call, from EnumDSSXMLDocSaveAsFlags.
        stateID - The ID of the state of the document to save.
        reportSaveAsOptions - The xml delta of the report SaveAs options for datasets within document.
        status - - EnumDSSXMLStatus - Contains the current status of the document.
        requestTimeout - Timeout in milliseconds for the xml command
        Returns:
        Object ID of the new document created.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 10.0.0

      • SaveAsSegment

        java.lang.String SaveAsSegment​(java.lang.String sessionID,
                               java.lang.String messageID,
                               java.lang.String folderID,
                               java.lang.String segmentName,
                               java.lang.String segmentDesc,
                               int flags,
                               java.lang.String nodeKey)
                        throws MSTRWebAPIException
        Create a segment from a document instance
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        folderID - The ID of the folder to save the Segment to.
        segmentName - The name of the new segment.
        segmentDesc - The description of the new segment.
        flags - Flags which modify the behavior of the call.
        nodeKey - Optional. If it's assigned, the segment would be create from the subtree rooted by this node. Otherwise the segment would be created from the root of the document.
        Returns:
        New Created Segment Object ID.
        Throws:
        MSTRWebAPIException

      • GetExecutionResultsEx

        java.lang.String GetExecutionResultsEx​(java.lang.String sessionID,
                                       java.lang.String messageID,
                                       int resultFlags,
                                       int stateID,
                                       int inboxMsgResultFlags,
                                       java.lang.String extendableParameter,
                                       IntWrapper status)
                                throws MSTRWebAPIException
        Obtains the execution results for a document in XML format.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        resultFlags - The result flags for the retrieval, from EnumDSSXMLDocResultFlags.
        extendableParameter - An XML parameter with additional information that modifies the output being returned.
        stateID - The state ID of the instance whose results are to be returned.
        status - The status of the document, from EnumDSSXMLStatus.
        inboxMsgResultFlags - for inbox message, value from EnumDSSXMLInboxMsgResultFlags.
        Returns:
        An XML string describing the document, if results are obtainable.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 8.0.0

      • GetExecutionResultsEx

        java.lang.String GetExecutionResultsEx​(java.lang.String sessionID,
                                       java.lang.String messageID,
                                       int resultFlags,
                                       int stateID,
                                       java.lang.String extendableParameter,
                                       IntWrapper status)
                                throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • GetFormatData

        byte[] GetFormatData​(java.lang.String sessionID,
                     java.lang.String messageID,
                     int format,
                     int stateID,
                     java.lang.String extendableParameter,
                     IntWrapper iwStatus)
              throws MSTRWebAPIException
        Returns formatted output for exporting a document.
        Parameters:
        sessionID - A valid Session ID.
        messageID - The message ID of the document instance.
        format - The format of the return value, from EnumDSSXMLExportFormat.
        stateID - The state ID of the document instance.
        extendableParameter - An XML string containing additional options.
        iwStatus - The status of the document instance, from EnumDSSXMLStatus.
        Returns:
        A byte array containing the data requested. This will be absent or present based on the status of the operation.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 7.5.0

      • GetExportFormatData

        byte[][] GetExportFormatData​(java.lang.String sessionID,
                             java.lang.String messageID,
                             int exportFormat,
                             int stateID,
                             java.lang.String extParams,
                             IntWrapper iwStatus)
                      throws MSTRWebAPIException
        Returns formatted output for exporting a document and the cache id.
        Parameters:
        sessionID - A valid Session ID.
        messageID - The message ID of the document instance.
        format - The format of the return value, from EnumDSSXMLExportFormat.
        stateID - The state ID of the document instance.
        extendableParameter - An XML string containing additional options.
        iwStatus - The status of the document instance, from EnumDSSXMLStatus.
        Returns:
        A 2D byte array containing the data requested + cache id. This will be absent or present based on the status of the operation.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 7.5.0

      • LoadGraph

        byte[] LoadGraph​(java.lang.String sessionID,
                 java.lang.String messageID,
                 int stateID,
                 java.lang.String templateKey,
                 int graphSliceIdentifier,
                 java.lang.String windowSetting,
                 int graphImgType,
                 java.lang.String graphProp,
                 IntWrapper iwStatus)
          throws MSTRWebAPIException
        Returns a graph that is contained within a document.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        stateID - The state ID of the document instance.
        templateKey - A value which tells the template in the document whose graph is being retrieved.
        graphSliceIdentifier - A value which identifies the slice of the graph to retrieve.
        windowSetting - An XML string telling the window of data to show in the graph returned.
        graphImgType - The image type of the graph, from EnumDSSXMLGraphImgTypes.
        graphProp - Properties that modify the graph shown.
        iwStatus - The status of the operation, from EnumDSSXMLStatus.
        Returns:
        A byte array containing the graph requested.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 8.0.0

      • LoadGraphData

        byte[][] LoadGraphData​(java.lang.String sessionID,
                       java.lang.String messageID,
                       int stateID,
                       java.lang.String templateKey,
                       int graphSliceIdentifier,
                       java.lang.String windowSetting,
                       int graphImgType,
                       java.lang.String graphProp,
                       IntWrapper iwStatus)
                throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • GetDocumentDatasetElements

        java.lang.String GetDocumentDatasetElements​(java.lang.String sessionID,
                                            java.lang.String messageID,
                                            java.lang.String datasetID,
                                            java.lang.String objectID,
                                            int type,
                                            java.lang.String filter,
                                            int blockBegin,
                                            int blockCount)
                                     throws MSTRWebAPIException
        Gets the elements XML from dataset.
        Parameters:
        sessionID - A valid Session ID
        messageID - The message ID of the document instance.
        datasetID - The id of the dataset where the elements from.
        objectID - The object for which to retrieve elements.
        type - The type of the object.
        filter - Filter to apply to browse action. [default=""]
        blockBegin - The starting element (used for incremental fetch). [default=1]
        blockCount - Number of elements to retrieve (used for incremental fetch). [default=-1]
        Returns:
        XML String representing the requested elements.
        Throws:
        MSTRWebAPIException - Signals an error condition.
        Since:
        MicroStrategy Web 8.0.1

      • GetDocumentDatasetElements

        java.lang.String GetDocumentDatasetElements​(java.lang.String sessionID,
                                            java.lang.String messageID,
                                            java.lang.String datasetID,
                                            java.lang.String objectID,
                                            int type,
                                            java.lang.String filter,
                                            int flags,
                                            int blockBegin,
                                            int blockCount)
                                     throws MSTRWebAPIException
        Gets the elements XML from dataset.
        Parameters:
        sessionID - A valid Session ID
        messageID - The message ID of the document instance.
        datasetID - The id of the dataset where the elements from.
        objectID - The object for which to retrieve elements.
        type - The type of the object.
        filter - Filter to apply to browse action. [default=""].
        flags - Flags to use when element browsing. This value comes from EnumDSSXMLGetElementsFlags.
        blockBegin - The starting element (used for incremental fetch). [default=1]
        blockCount - Number of elements to retrieve (used for incremental fetch). [default=-1]
        Returns:
        XML String representing the requested elements.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • GetDocumentDatasetElements

        java.lang.String GetDocumentDatasetElements​(java.lang.String sessionID,
                                            java.lang.String messageID,
                                            java.lang.String datasetID,
                                            java.lang.String objectID,
                                            int type,
                                            java.lang.String filter,
                                            int flags,
                                            int blockBegin,
                                            int blockCount,
                                            java.lang.String controlKey)
                                     throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • GetDocumentDatasetElements

        java.lang.String GetDocumentDatasetElements​(java.lang.String sessionID,
                                            java.lang.String messageID,
                                            java.lang.String datasetID,
                                            java.lang.String objectID,
                                            int type,
                                            java.lang.String filter,
                                            int flags,
                                            int blockBegin,
                                            int blockCount,
                                            java.lang.String controlKey,
                                            java.lang.String templateKey,
                                            java.lang.String rawInput)
                                     throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • GetDocumentDatasetElements

        java.lang.String GetDocumentDatasetElements​(java.lang.String sessionID,
                                            java.lang.String messageID,
                                            java.lang.String datasetID,
                                            java.lang.String objectID,
                                            int type,
                                            java.lang.String filter,
                                            int flags,
                                            int blockBegin,
                                            int blockCount,
                                            java.lang.String controlKey,
                                            java.lang.String templateKey,
                                            java.lang.String rawInput,
                                            boolean useBrowseForm)
                                     throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • GetDocumentDatasetElements

        java.lang.String GetDocumentDatasetElements​(java.lang.String sessionID,
                                            java.lang.String messageID,
                                            java.lang.String datasetID,
                                            java.lang.String objectID,
                                            int type,
                                            java.lang.String filter,
                                            int flags,
                                            int blockBegin,
                                            int blockCount,
                                            java.lang.String controlKey,
                                            java.lang.String templateKey,
                                            java.lang.String rawInput,
                                            boolean useBrowseForm,
                                            java.lang.String objectCurrentConditionXML)
                                     throws MSTRWebAPIException
        Gets the elements XML from dataset.
        Parameters:
        sessionID - A valid Session ID
        messageID - The message ID of the document instance.
        datasetID - The id of the dataset where the elements from.
        objectID - The object for which to retrieve elements.
        type - The type of the object.
        filter - Filter to apply to browse action. [default=""].
        flags - Flags to use when element browsing. This value comes from EnumDSSXMLGetElementsFlags.
        blockBegin - The starting element (used for incremental fetch). [default=1]
        blockCount - Number of elements to retrieve (used for incremental fetch). [default=-1]
        controlKey -
        templateKey -
        rawInput -
        useBrowseForm -
        objectCurrentConditionXML - Object Current condition XML -added for populating target filter based on current filter selection without changing I-server state [default ""]
        Returns:
        XML String representing the requested elements.
        Throws:
        MSTRWebAPIException
        Since:
        MicroStrategy Web 10.3

      • SendBinaryData

        void SendBinaryData​(java.lang.String sessionID,
                    java.lang.String messageID,
                    int format,
                    int stateID,
                    java.lang.String extendableParameter,
                    IContentConsumer consumer)
             throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException
        Since:
        MicroStrategy Web 9.0.0

      • SaveDerivedElements

        java.lang.String SaveDerivedElements​(java.lang.String sessionID,
                                     java.lang.String messageID,
                                     java.lang.String unitKey,
                                     java.lang.String attId,
                                     java.lang.String folderId,
                                     java.lang.String name,
                                     java.lang.String description,
                                     boolean overwrite,
                                     IntWrapper status)
                              throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException
        Since:
        MicroStrategy Web 9.0.0

      • SendExecutionResultsInBinary

        void SendExecutionResultsInBinary​(java.lang.String sessionID,
                                  java.lang.String messageID,
                                  int resultFlags,
                                  int detailFlags,
                                  int stateID,
                                  java.lang.Integer mbs,
                                  java.lang.String extendableParameter,
                                  IntWrapper iwStatus,
                                  IContentConsumer consumer)
                           throws MSTRWebAPIException
        Obtains the results/data of the document in binary format. Currently this is used to retrieve the data for the flex model in binary format. Note that the parameters like resultFlags and extendableParameter are currently not used and have been added for future use. Hence this method will always return the flex data in binary format at present.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        resultFlags - The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
        detailFlags - The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
        stateID - The state ID of the document instance.
        mbs - Maximum binary size (optional).
        extendableParameter - An XML string containing additional options.
        iwStatus - The status of the document instance, from EnumDSSXMLStatus.
        consumer - A IContentConsumer object which consumes the binary data that is generated by the intelligence server
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.

      • SendExecutionResultsInBinary

        void SendExecutionResultsInBinary​(java.lang.String sessionID,
                                  java.lang.String messageID,
                                  int resultFlags,
                                  int detailFlags,
                                  int stateID,
                                  java.lang.Integer mbs,
                                  java.util.HashMap<java.lang.String,​java.lang.String> mobileProps,
                                  java.lang.String extendableParameter,
                                  IntWrapper iwStatus,
                                  IContentConsumer consumer)
                           throws MSTRWebAPIException
        Obtains the results/data of the document in binary format. Currently this is used to retrieve the data for the flex model in binary format. Note that the parameters like resultFlags and extendableParameter are currently not used and have been added for future use. Hence this method will always return the flex data in binary format at present.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        resultFlags - The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
        detailFlags - The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
        stateID - The state ID of the document instance.
        mbs - Maximum binary size (optional).
        mobileProps - A collection of mobile properties that need to be passed to backend. Expected properties are MOBILE_PROPERTY_ENCRYPT, MOBILE_PROPERTY_DEVICE_TOKEN, MOBILE_PROPERTY_APP_ID or MOBILE_PROPERTY_TOKEN_TYPE
        extendableParameter - An XML string containing additional options.
        iwStatus - The status of the document instance, from EnumDSSXMLStatus.
        consumer - A IContentConsumer object which consumes the binary data that is generated by the intelligence server
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.

      • SendExecutionResultsInBinary

        @Deprecated
void SendExecutionResultsInBinary​(java.lang.String sessionID,
                                  java.lang.String messageID,
                                  int resultFlags,
                                  int stateID,
                                  java.lang.String extendableParameter,
                                  IntWrapper iwStatus,
                                  IContentConsumer consumer)
                           throws MSTRWebAPIException
        Deprecated.
        This method is deprecated. Use the overloading method with detailFlags instead.
        Obtains the results/data of the document in binary format. Currently this is used to retrieve the data for the flex model in binary format. Note that the parameters like resultFlags and extendableParameter are currently not used and have been added for future use. Hence this method will always return the flex data in binary format at present.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        resultFlags - The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
        stateID - The state ID of the document instance.
        extendableParameter - An XML string containing additional options.
        iwStatus - The status of the document instance, from EnumDSSXMLStatus.
        consumer - A IContentConsumer object which consumes the binary data that is generated by the intelligence server
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 9.0.0

      • GetExecutionResultsInBinary

        byte[] GetExecutionResultsInBinary​(java.lang.String sessionID,
                                   java.lang.String messageID,
                                   int resultFlags,
                                   int detailFlags,
                                   int stateID,
                                   java.lang.Integer mbs,
                                   java.lang.String extendableParameter,
                                   IntWrapper iwStatus)
                            throws MSTRWebAPIException
        Obtains the results/data of the document in binary format.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        resultFlags - The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
        detailFlags - The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
        stateID - The state ID of the document instance.
        mbs - Maximum binary size (optional).
        extendableParameter - An XML string containing additional options.
        iwStatus - The status of the document instance, from EnumDSSXMLStatus.
        Returns:
        The byte array representing the binary data of the document
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.

      • GetCacheInfoJsonResult

        java.lang.String GetCacheInfoJsonResult​(java.lang.String sessionID,
                                        java.lang.String messageID,
                                        int resultFlags,
                                        int detailFlags,
                                        int stateID,
                                        java.lang.String extendableParameter,
                                        IntWrapper iwStatus)
                                 throws MSTRWebAPIException
        THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT. Obtains the cache info json string of the document in json format.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        resultFlags - The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
        detailFlags - The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
        stateID - The state ID of the document instance.
        extendableParameter - An XML string containing additional options.
        iwStatus - The status of the document instance, from EnumDSSXMLStatus.
        Returns:
        The byte array representing the binary data of the document
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        java.lang.IllegalArgumentException - Thrown if resultFlag doesn't include EnumDSSXMLBinaryContextFlags.DssBinaryContextFlexCacheInfoOnly.

      • GetCacheInfoJsonResult

        java.lang.String GetCacheInfoJsonResult​(java.lang.String sessionID,
                                        java.lang.String messageID,
                                        int resultFlags,
                                        int detailFlags,
                                        int stateID,
                                        java.lang.String extendableParameter,
                                        IntWrapper iwStatus,
                                        int resultType)
                                 throws MSTRWebAPIException
        THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT. Obtains the cache info json string of the document in json format.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        resultFlags - The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
        detailFlags - The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
        stateID - The state ID of the document instance.
        extendableParameter - An XML string containing additional options.
        iwStatus - The status of the document instance, from EnumDSSXMLStatus.
        resultType - The expected result type.
        Returns:
        The byte array representing the binary data of the document
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        java.lang.IllegalArgumentException - Thrown if resultFlag doesn't include EnumDSSXMLBinaryContextFlags.DssBinaryContextFlexCacheInfoOnly.

      • GetExecutionResultsInBinary

        byte[] GetExecutionResultsInBinary​(java.lang.String sessionID,
                                   java.lang.String messageID,
                                   int resultFlags,
                                   int detailFlags,
                                   int stateID,
                                   java.lang.Integer mbs,
                                   java.util.HashMap<java.lang.String,​java.lang.String> mobileProps,
                                   java.lang.String extendableParameter,
                                   IntWrapper iwStatus)
                            throws MSTRWebAPIException
        Obtains the results/data of the document in binary format.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        resultFlags - The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
        detailFlags - The detail flags for the retrieval, from EnumDSSXMLBinaryContextDetailFlags.
        stateID - The state ID of the document instance.
        mbs - Maximum binary size (optional).
        mobileProps - A collection of mobile properties that need to be passed to backend. Expected properties are MOBILE_PROPERTY_ENCRYPT, MOBILE_PROPERTY_DEVICE_TOKEN, MOBILE_PROPERTY_APP_ID or MOBILE_PROPERTY_TOKEN_TYPE
        extendableParameter - An XML string containing additional options.
        iwStatus - The status of the document instance, from EnumDSSXMLStatus.
        Returns:
        The byte array representing the binary data of the document
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.

      • GetExecutionResultsInBinary

        @Deprecated
byte[] GetExecutionResultsInBinary​(java.lang.String sessionID,
                                   java.lang.String messageID,
                                   int resultFlags,
                                   int stateID,
                                   java.lang.String extendableParameter,
                                   IntWrapper iwStatus)
                            throws MSTRWebAPIException
        Deprecated.
        This method is deprecated. Use the overloading method with detailFlags instead.
        Obtains the results/data of the document in binary format. Currently this is used to retrieve the data for the flex model in binary format. Note that the parameters like resultFlags and extendableParameter are currently not used and have been added for future use. Hence this method will always return the flex data in binary format at present.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        resultFlags - The result flags for the retrieval, from EnumDSSXMLBinaryContextFlags.
        stateID - The state ID of the document instance.
        extendableParameter - An XML string containing additional options.
        iwStatus - The status of the document instance, from EnumDSSXMLStatus.
        Returns:
        The byte array representing the binary data of the document
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 9.0.0

      • GetExecutionResultsAsStream

        IResultsAsStream GetExecutionResultsAsStream​(java.lang.String sessionID,
                                             java.lang.String messageID,
                                             int resultFlags,
                                             int stateID,
                                             java.lang.String extendableParameter,
                                             int inboxMsgResultFlags)
                                      throws MSTRWebAPIException
        Obtains the execution results for a document as IResultsAsStream object.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        resultFlags - The result flags for the retrieval, from EnumDSSXMLDocResultFlags.
        extendableParameter - An XML parameter with additional information that modifies the output being returned.
        stateID - The state ID of the instance whose results are to be returned.
        inboxMsgResultFlags - for history list, value from EnumDSSXMLInboxMsgResultFlags
        Returns:
        Results as stream object
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.

      • LoadGraph

        void LoadGraph​(java.lang.String sessionID,
               java.lang.String messageID,
               int stateID,
               java.lang.String nodeKey,
               int slicedWindowID,
               java.lang.String windowSetting,
               int graphImgType,
               java.lang.String graphProp,
               IContentConsumer consumer)
        throws MSTRWebAPIException
        Obtains graph data from backend and steams it to provided content consumer.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        stateID - The state ID of the document instance.
        nodeKey - A value which tells the template in the document whose graph is being retrieved.
        slicedWindowID - A value which identifies the slice of the graph to retrieve.
        windowSetting - An XML string telling the window of data to show in the graph returned.
        graphImgType - The image type of the graph, from EnumDSSXMLGraphImgTypes.
        graphProp - Properties that modify the graph shown.
        consumer - A content consumer for graph data
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status)
                  throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey)
                  throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey,
                         int dossierFlags)
                  throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey,
                         int dossierFlags,
                         boolean isDossier)
                  throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey,
                         int dossierFlags,
                         boolean isDossier,
                         PersonalViewExecutionInfo pvInfo)
                  throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey,
                         int dossierFlags,
                         boolean isDossier,
                         PersonalViewExecutionInfo pvInfo,
                         java.lang.String subscriptionId,
                         java.lang.String bookmarkID)
                  throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey,
                         int dossierFlags,
                         boolean isDossier,
                         PersonalViewExecutionInfo pvInfo,
                         java.lang.String subscriptionId,
                         java.lang.String bookmarkID,
                         boolean isReport)
                  throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey,
                         int dossierFlags,
                         boolean isDossier,
                         PersonalViewExecutionInfo pvInfo,
                         java.lang.String subscriptionId,
                         java.lang.String bookmarkID,
                         boolean isReport,
                         boolean manipulationsAutoSavingDisabled)
                  throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey,
                         int dossierFlags,
                         boolean isDossier,
                         PersonalViewExecutionInfo pvInfo,
                         java.lang.String subscriptionId,
                         java.lang.String bookmarkID,
                         boolean manipulationsAutoSavingDisabled,
                         int evaluationLevel)
                  throws MSTRWebAPIException
        Execute an XML document by XML document ID.

        ExecutionFlag is a value from the enumeration EnumDSSXMLDocExecutionFlags. You need to set it to DssXmlDocExecutionHTML to get the HTML returned. If an error happens while the XML document is being executed, an error message will be returned in the executionResults. Otherwise an inbox message ID will be returned in the messageID output parameter. You need to use GetExecutionResults to retrieve the results.

        With promptAnswer , the caller can provide answers to prompts in the document before running it.

        The status of the function call indicates the execution status. See the flags section for details.

        Parameters:
        sessionID - A valid session ID.
        documentID - The object ID of the document to execute.
        executionFlags - specifies options for the execution of the document. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlags. [Default=0]
        resultFlags - Flags to apply to the result of the execution. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocResultFlags. [Default=0]
        promptAnswer - Pre-answer for prompting. This is used if it is known that the document has a prompt in it, and the answer XML is already known. [Default=""]
        extParam - indicates any applicable extendable parameters
        styleXSL - XSL for the document style. [Default=""]
        delta - Addition XML for manipulations or other operations defined in XML API(refer relevant documents for details
        messageID - Output Parameter - The job ID of the request. This is needed when checking the status of the document execution.
        status - Output Parameter The current status of the request. Value comes from EnumDSSXMLStatus.
        manipulationsAutoSavingDisabled - Specific for personal view.
        evaluationLevel - For computation on demand, 0--all; 1--chapter(layout); 2--page(not supported yet)
        Returns:
        If the document is ready upon returning, this will be an XML String representing the document. If not, this will be null.
        Throws:
        MSTRWebAPIException - Signals an error condition.

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey,
                         int dossierFlags,
                         boolean isDossier,
                         PersonalViewExecutionInfo pvInfo,
                         java.lang.String subscriptionId)
                  throws MSTRWebAPIException
        Execute an XML document by XML document ID.
        Parameters:
        sessionID - A valid session ID.
        documentID - The object ID of the document to execute.
        executionFlags - specifies options for the execution of the document. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlags. [Default=0]
        resultFlags - Flags to apply to the result of the execution. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocResultFlags. [Default=0]
        promptAnswer - Pre-answer for prompting. This is used if it is known that the document has a prompt in it, and the answer XML is already known. [Default=""]
        extParam - indicates any applicable extendable parameters
        styleXSL - XSL for the document style. [Default=""]
        delta -
        messageID - Output Parameter - The job ID of the request. This is needed when checking the status of the document execution.
        status - Output Parameter The current status of the request. Value comes from EnumDSSXMLStatus.
        topMsgID -
        nodeKey - set target node key if there is a topMsgID, mainly created for dossier
        dossierFlags -
        isDossier - For Dossier. Generates object_id tag instead of doc_id to enable search for dossier shortcut
        isPartial - in case the execution of the applied deltas only succeeded for a few but not all
        subscriptionId - The subscription id when the execution originates from a subscription
        Returns:
        Throws:
        MSTRWebAPIException

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey,
                         int dossierFlags,
                         boolean isDossier,
                         PersonalViewExecutionInfo pvInfo,
                         java.lang.String subscriptionId,
                         java.lang.String bookmarkID,
                         boolean manipulationsAutoSavingDisabled,
                         int evaluationLevel,
                         java.lang.String[] sharedBookmarkIds)
                  throws MSTRWebAPIException
        Execute an XML document by XML document ID.
        Parameters:
        sessionID - A valid session ID.
        documentID - The object ID of the document to execute.
        executionFlags - specifies options for the execution of the document. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlags. [Default=0]
        resultFlags - Flags to apply to the result of the execution. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocResultFlags. [Default=0]
        promptAnswer - Pre-answer for prompting. This is used if it is known that the document has a prompt in it, and the answer XML is already known. [Default=""]
        extParam - indicates any applicable extendable parameters
        styleXSL - XSL for the document style. [Default=""]
        delta -
        messageID - Output Parameter - The job ID of the request. This is needed when checking the status of the document execution.
        status - Output Parameter The current status of the request. Value comes from EnumDSSXMLStatus.
        topMsgID -
        nodeKey - set target node key if there is a topMsgID, mainly created for dossier
        dossierFlags -
        isDossier - For Dossier. Generates object_id tag instead of doc_id to enable search for dossier shortcut
        isPartial - in case the execution of the applied deltas only succeeded for a few but not all
        subscriptionId - The subscription id when the execution originates from a subscription
        sharedBookmarkIds - The shared bookmark id list when the execution originates from bookmarks sharing.
        Returns:
        Throws:
        MSTRWebAPIException

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey,
                         int dossierFlags,
                         boolean isDossier,
                         PersonalViewExecutionInfo pvInfo,
                         java.lang.String subscriptionId,
                         java.lang.String bookmarkID,
                         boolean manipulationsAutoSavingDisabled,
                         int evaluationLevel,
                         java.lang.String[] sharedBookmarkIds,
                         int executionFlagsExtension)
                  throws MSTRWebAPIException
        Execute an XML document by XML document ID.
        Parameters:
        sessionID - A valid session ID.
        documentID - The object ID of the document to execute.
        executionFlags - specifies options for the execution of the document. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlags. [Default=0]
        resultFlags - Flags to apply to the result of the execution. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocResultFlags. [Default=0]
        promptAnswer - Pre-answer for prompting. This is used if it is known that the document has a prompt in it, and the answer XML is already known. [Default=""]
        extParam - indicates any applicable extendable parameters
        styleXSL - XSL for the document style. [Default=""]
        delta -
        messageID - Output Parameter - The job ID of the request. This is needed when checking the status of the document execution.
        status - Output Parameter The current status of the request. Value comes from EnumDSSXMLStatus.
        topMsgID -
        nodeKey - set target node key if there is a topMsgID, mainly created for dossier
        dossierFlags -
        isDossier - For Dossier. Generates object_id tag instead of doc_id to enable search for dossier shortcut
        subscriptionId - The subscription id when the execution originates from a subscription
        sharedBookmarkIds - The shared bookmark id list when the execution originates from bookmarks sharing.
        executionFlagsExtension - specifies options for the execution flags extension of the document. Values must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlagsExtension [Default=0]
        Returns:
        Throws:
        MSTRWebAPIException

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey,
                         int dossierFlags,
                         boolean isDossier,
                         PersonalViewExecutionInfo pvInfo,
                         java.lang.String subscriptionId,
                         java.lang.String bookmarkID,
                         boolean manipulationsAutoSavingDisabled,
                         int evaluationLevel,
                         java.lang.String[] sharedBookmarkIds,
                         int executionFlagsExtension,
                         java.lang.String applicationId)
                  throws MSTRWebAPIException
        Execute an XML document by XML document ID.
        Parameters:
        sessionID - A valid session ID.
        documentID - The object ID of the document to execute.
        executionFlags - specifies options for the execution of the document. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlags. [Default=0]
        resultFlags - Flags to apply to the result of the execution. Value must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocResultFlags. [Default=0]
        promptAnswer - Pre-answer for prompting. This is used if it is known that the document has a prompt in it, and the answer XML is already known. [Default=""]
        extParam - indicates any applicable extendable parameters
        styleXSL - XSL for the document style. [Default=""]
        delta -
        messageID - Output Parameter - The job ID of the request. This is needed when checking the status of the document execution.
        status - Output Parameter The current status of the request. Value comes from EnumDSSXMLStatus.
        topMsgID -
        nodeKey - set target node key if there is a topMsgID, mainly created for dossier
        dossierFlags -
        isDossier - For Dossier. Generates object_id tag instead of doc_id to enable search for dossier shortcut
        pvInfo -
        subscriptionId - The subscription id when the execution originates from a subscription
        sharedBookmarkIds - The shared bookmark id list when the execution originates from bookmarks sharing.
        executionFlagsExtension - specifies options for the execution flags extension of the document. Values must be a bitwise "and" using the values in the enumeration EnumDSSXMLDocExecutionFlagsExtension [Default=0]
        applicationId - The library application id when the execution originates within an application
        Returns:
        Throws:
        MSTRWebAPIException

      • Execute

        java.lang.String Execute​(java.lang.String sessionID,
                         java.lang.String documentID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         java.lang.String delta,
                         StringWrapper messageID,
                         IntWrapper status,
                         java.lang.String topMsgID,
                         java.lang.String nodeKey,
                         int dossierFlags,
                         boolean isDossier,
                         PersonalViewExecutionInfo pvInfo,
                         java.lang.String subscriptionId,
                         java.lang.String bookmarkID,
                         boolean manipulationsAutoSavingDisabled,
                         int evaluationLevel,
                         java.lang.String[] sharedBookmarkIds,
                         int executionFlagsExtension,
                         java.lang.String applicationId,
                         boolean isReport)
                  throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • ResumeImportAsyncDashboard

        void ResumeImportAsyncDashboard​(java.lang.String sessionID,
                                java.lang.String messageID,
                                java.lang.String dashboardName)
                         throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • ImportAsyncDashboard

        java.lang.String ImportAsyncDashboard​(java.lang.String sessionID,
                                      java.io.InputStream data,
                                      long fileLength,
                                      java.lang.String folderID,
                                      java.lang.String dashboardName,
                                      java.lang.String dashboardDescription,
                                      IntWrapper status)
                               throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • GetJsonResults

        java.lang.String GetJsonResults​(java.lang.String sessionID,
                                java.lang.String messageID,
                                int resultFlags,
                                int detailFalgs,
                                int stateID,
                                java.lang.String extendableParameter,
                                IntWrapper status)
                         throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • GetDossierTocResults

        java.lang.String GetDossierTocResults​(java.lang.String sessionID,
                                      java.lang.String messageID,
                                      java.lang.String dossierId,
                                      java.lang.String objectType,
                                      int resultFlags,
                                      IntWrapper status)
                               throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • GetJsonResults

        java.lang.String GetJsonResults​(java.lang.String sessionID,
                                java.lang.String messageID,
                                int resultFlags,
                                int detailFalgs,
                                int stateID,
                                java.lang.String extendableParameter,
                                IntWrapper status,
                                int mode)
                         throws MSTRWebAPIException
        THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT.
        Throws:
        MSTRWebAPIException

      • GetJsonResults

        java.lang.Object GetJsonResults​(java.lang.String sessionID,
                                java.lang.String messageID,
                                int resultFlags,
                                int detailFalgs,
                                int stateID,
                                java.lang.String extendableParameter,
                                IntWrapper status,
                                int mode,
                                int version)
                         throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • getManifest

        java.lang.String getManifest​(java.lang.String sessionID,
                             java.lang.String messageID,
                             java.lang.String datasetId,
                             java.lang.Boolean useJson)
                      throws MSTRWebAPIException
        get manifest of the document, returns a list of objects used in the document
        Parameters:
        sessionID -
        messageID -
        status -
        Returns:
        Throws:
        MSTRWebAPIException

      • Refresh

        java.lang.String Refresh​(java.lang.String sessionID,
                         java.lang.String messageID,
                         int stateID,
                         int executionFlags,
                         int resultFlags,
                         java.lang.String promptAnswer,
                         java.lang.String deltaXML,
                         java.lang.String extParam,
                         java.lang.String styleXSL,
                         IntWrapper status)
                  throws MSTRWebAPIException
        Throws:
        MSTRWebAPIException

      • getBaseGraphProperties

        java.lang.String getBaseGraphProperties​(java.lang.String sessionID,
                                        java.lang.String projectID)
                                 throws MSTRWebAPIException
        get base graph properties.
        Parameters:
        sessionID - A valid session ID.
        projectID - project dss id.
        Returns:
        properties with JSON format.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.

      • getDocumentLinksValidationInfo

        java.lang.String getDocumentLinksValidationInfo​(java.lang.String sessionID,
                                                java.lang.String messageID,
                                                int action,
                                                java.lang.String extendableParameter)
                                         throws MSTRWebAPIException
        get validation info for document level attribute links
        Parameters:
        sessionID - A valid Session ID.
        messageID - A valid message/job ID.
        extendableParameter - The extendable parameter value.
        Returns:
        validation info with JSON format.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.

      • getElementFromGraph

        java.lang.String getElementFromGraph​(java.lang.String sessionID,
                                     java.lang.String messageID,
                                     java.lang.String nodeKey,
                                     java.lang.String sliceID,
                                     int x,
                                     int y,
                                     java.lang.String dpi)
                              throws MSTRWebAPIException
        get elements from graph in document
        Parameters:
        sessionID - A valid Session ID.
        messageID - A valid message ID.
        nodeKey - node key
        sliceID - slice ID
        x - position X
        y - position Y
        dpi - DPI
        Returns:
        the elements clicked in the graph
        Throws:
        MSTRWebAPIException

      • getElementFromGraph

        java.lang.String getElementFromGraph​(java.lang.String sessionID,
                                     java.lang.String messageID,
                                     java.lang.String nodeKey,
                                     java.lang.String sliceID,
                                     int x,
                                     int y,
                                     int width,
                                     int height,
                                     java.lang.String dpi)
                              throws MSTRWebAPIException
        get elements from graph in document
        Parameters:
        sessionID - A valid Session ID.
        messageID - A valid message ID.
        nodeKey - node key
        sliceID - slice ID
        x - position X
        y - position Y
        width - width of graph
        height - height of graph
        dpi - DPI
        Returns:
        the elements clicked in the graph
        Throws:
        MSTRWebAPIException

      • SaveAsTheme

        java.lang.String SaveAsTheme​(java.lang.String sessionID,
                             java.lang.String messageID,
                             java.lang.String folderID,
                             java.lang.String themeName,
                             java.lang.String themeDesc,
                             int flags,
                             int stateID)
                      throws MSTRWebAPIException
        Saves the given theme instance to metadata.
        Parameters:
        sessionID - A valid session ID.
        messageID - The message ID of the document instance.
        folderID - The ID of the folder to save the theme to.
        themeName - The name to save the theme as.
        themeDesc - The description of the theme.
        flags - Flags which modify the behavior of the call, from EnumDSSXMLDocSaveAsFlags.
        stateID - The ID of the state of the document to save.
        Returns:
        Object ID of the new document theme created.
        Throws:
        MSTRWebAPIException - Thrown if an error occurs.
        Since:
        MicroStrategy Web 10.0.0

      • importImageToDocument

        java.lang.String importImageToDocument​(java.lang.String sessionID,
                                       java.lang.String messageID,
                                       java.lang.String binaryID,
                                       int blockCount,
                                       int blockIndex,
                                       int blockSize,
                                       java.lang.String treeType,
                                       java.lang.String nodeKey,
                                       java.lang.String fieldKey,
                                       java.lang.String fieldName,
                                       java.lang.String imgName,
                                       int index,
                                       long fileSize,
                                       java.lang.String imgID,
                                       java.lang.String hashCode,
                                       int isEdit,
                                       java.io.InputStream data)
                                throws MSTRWebAPIException
        import image to document
        Parameters:
        sessionID - A valid Session ID
        messageID - A valid message ID
        binaryID - the ID of binary of image if it is too large, and need to be partitioned.
        blockCount - the number of blocks of the image if it is too large, and need to be partitioned.
        blockIndex - the index of block of the image if it is too large, and need to be partitioned.
        blockSize - the size of the block of the image if it is too large, and need to be partitioned.
        isEdit - the flag that indicate edit current node or add a new node(1 edit, 0 add)
        treeType - tree type
        nodeKey - node key
        fieldKey - field key
        fieldName - field name
        imgName - image name
        index - the index of the field in field group
        fileSize - size of the image
        data - the binary stream of the image/block
        Returns:
        the ID of binary of image if it is too large, and need to be partitioned
        Throws:
        MSTRWebAPIException

      • checkImageExist

        java.lang.String checkImageExist​(java.lang.String sessionID,
                                 java.lang.String messageID,
                                 java.lang.String shaValue)
                          throws MSTRWebAPIException
        check whether the image has been stored in MD or in current instance
        Parameters:
        sessionID - A valid Session ID
        messageID - A valid message ID
        shaValue - the SHA result of image binary stream
        Returns:
        If the image exists, return the id of the image. else return a string with all zero
        Throws:
        MSTRWebAPIException

      • getDocumentShortcutInfo

        java.lang.String getDocumentShortcutInfo​(java.lang.String sessionID,
                                         java.lang.String objectId)
                                  throws MSTRWebAPIException
        Gets the shortcut information by the shortcut objectId
        Parameters:
        sessionID -
        objectId - document shortcut's object ID. I-Server will find the corresponding shortcut from MD.
        Returns:
        Throws:
        MSTRWebAPIException

      • getDocumentInstanceShortcutInfo

        java.lang.String getDocumentInstanceShortcutInfo​(java.lang.String sessionID,
                                                 java.lang.String messageId)
                                          throws MSTRWebAPIException
        Gets the shortcut information associated with an instanceId (messageId) of a document
        Parameters:
        sessionID -
        messageId - server message ID. I-Server will get shortcut from server message. If the server message contains a document instance, and the document instance is created because of running a shortcut, then client can use the mid to get shortcut info
        Returns:
        Throws:
        MSTRWebAPIException

      • getDocumentShortcutInfo

        java.lang.String getDocumentShortcutInfo​(java.lang.String sessionID,
                                         java.lang.String objectId,
                                         int dossierShortcutInfoFlag)
                                  throws MSTRWebAPIException
        Gets the shortcut information by the shortcut objectId. A flag can be used to specify additional information to be returned in the result.
        Parameters:
        sessionID -
        objectId - document shortcut's object ID. I-Server will find the corresponding shortcut from MD.
        dossierShortcutInfoFlag - flag to specify what additional information needs to be returned. For more information, please refer to EnumDSSXMLDossierShortcutInfoFlag.
        Returns:
        Throws:
        MSTRWebAPIException

      • getDocumentInstanceShortcutInfo

        java.lang.String getDocumentInstanceShortcutInfo​(java.lang.String sessionID,
                                                 java.lang.String messageId,
                                                 int dossierShortcutInfoFlag)
                                          throws MSTRWebAPIException
        Gets the shortcut information associated with an instanceId (messageId) of a document. A flag can be used to specify additional information to be returned in the result.
        Parameters:
        sessionID -
        messageId - server message ID. I-Server will get shortcut from server message. If the server message contains a document instance, and the document instance is created because of running a shortcut, then client can use the mid to get shortcut info
        dossierShortcutInfoFlag - flag to specify what additional information needs to be returned. For more information, please refer to EnumDSSXMLDossierShortcutInfoFlag.
        Returns:
        Throws:
        MSTRWebAPIException

      • getMSTRPredictedFileSize

        java.lang.String getMSTRPredictedFileSize​(java.lang.String sessionID,
                                          java.lang.String objectID)
                                   throws MSTRWebAPIException
        Gets the predicted MSTR file size of a report or a document
        Parameters:
        sessionID -
        objectID - objectID of a document or a report
        Returns:
        a json String e.g.{"mstr_size":0,"IsSetting":false}, the "mstr_size" is the predicted MSTR file size calculated by the i-Server. "IsSetting" indicates if the "mstr_size" is obtained by returning the value of 'MicroStrategy .(mstr) file size(MB)' set on the developer directly. If IsSetting is true meaning that the value of "mstr_size" was returned based on the value of 'MicroStrategy .(mstr) file size(MB)' set on developer; if IsSetting is false meaning that the value of "mstr_size" was calculated for a given document or report by the i-Server.
        Throws:
        MSTRWebAPIException

      • getDossierShortcutCachesInBinary

        byte[] getDossierShortcutCachesInBinary​(java.lang.String sessionID,
                                        java.lang.String cacheId)
                                 throws MSTRWebAPIException
        Gets the dossier shortcut cache binary by cache id, only support one cache id in 11.1 THIS METHOD IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE METHOD IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT.
        Parameters:
        sessionID -
        caches - cache id
        Returns:
        Throws:
        MSTRWebAPIException

      • getDossierShortcutCacheInfoJsonResult

        java.lang.String getDossierShortcutCacheInfoJsonResult​(java.lang.String sessionID,
                                                       int cacheType,
                                                       java.lang.String shortcutId)
                                                throws MSTRWebAPIException
        Get the cache info include definition cache and data cache for a dossier shortcut Internal used only
        Parameters:
        sessionID - project session id
        cacheType - EnumDSSExportFormat - Flag to indicate export format. Now only support DssExportFormatFlash = 7
        shortcutId - dossier shortcut id
        Returns:
        Throws:
        MSTRWebAPIException
        Since:
        MSTR 11.1

      • getDossierShortcutCacheInfoJsonResult

        java.lang.String getDossierShortcutCacheInfoJsonResult​(java.lang.String sessionID,
                                                       int cacheType,
                                                       java.lang.String shortcutId,
                                                       java.lang.Integer resultFlags,
                                                       java.lang.Integer detailFlags,
                                                       java.lang.String bookmarkId)
                                                throws MSTRWebAPIException
        Get the cache info include definition cache and data cache for a dossier shortcut Internal used only
        Parameters:
        sessionID - project session id
        cacheType - EnumDSSExportFormat - Flag to indicate export format. Now only support DssExportFormatFlash = 7
        shortcutId - dossier shortcut id
        resultFlags - result flags
        detailFlags - detail flags
        bookmarkId - bookmark id
        Returns:
        Throws:
        MSTRWebAPIException

      • getDossierShortcutCacheInfoJsonResult

        java.lang.String getDossierShortcutCacheInfoJsonResult​(java.lang.String sessionID,
                                                       int cacheType,
                                                       java.lang.String shortcutId,
                                                       java.lang.Integer resultFlags,
                                                       java.lang.Integer detailFlags,
                                                       java.lang.Integer shortcutCacheInfoFlag,
                                                       java.lang.String bookmarkId)
                                                throws MSTRWebAPIException
        Get the cache info include definition cache and data cache for a dossier shortcut Internal used only
        Parameters:
        sessionID - project session id
        cacheType - EnumDSSExportFormat - Flag to indicate export format. Now only support DssExportFormatFlash = 7
        shortcutId - dossier shortcut id
        resultFlags - result flags
        detailFlags - detail flags
        shortcutCacheInfoFlag - shortcut cache info flag
        bookmarkId - bookmark id
        Returns:
        Throws:
        MSTRWebAPIException

      • getDossierShortcutCacheInfoJsonResult

        java.lang.String getDossierShortcutCacheInfoJsonResult​(java.lang.String sessionID,
                                                       int cacheType,
                                                       java.lang.String shortcutId,
                                                       java.lang.String instanceId,
                                                       java.lang.Integer resultFlags,
                                                       java.lang.Integer detailFlags,
                                                       java.lang.Integer shortcutCacheInfoFlag)
                                                throws MSTRWebAPIException
        Get the cache info include definition cache and data cache for a dossier shortcut Internal used only
        Parameters:
        sessionID - project session id
        cacheType - EnumDSSExportFormat - Flag to indicate export format. Now only support DssExportFormatFlash = 7
        shortcutId - dossier shortcut id
        instanceId - dossier instance id
        resultFlags - result flags
        detailFlags - detail flags
        shortcutCacheInfoFlag - shortcut cache info flag
        Returns:
        Throws:
        MSTRWebAPIException

      • getDossierShortcutCacheInfoJsonResult

        java.lang.String getDossierShortcutCacheInfoJsonResult​(java.lang.String sessionID,
                                                       int cacheType,
                                                       java.lang.String shortcutId,
                                                       java.lang.String instanceId,
                                                       java.lang.Integer resultFlags,
                                                       java.lang.Integer detailFlags,
                                                       java.lang.Integer shortcutCacheInfoFlag,
                                                       java.lang.String bookmarkId)
                                                throws MSTRWebAPIException
        Get the cache info include definition cache and data cache for a dossier shortcut Internal used only
        Parameters:
        sessionID - project session id
        cacheType - EnumDSSExportFormat - Flag to indicate export format. Now only support DssExportFormatFlash = 7
        shortcutId - dossier shortcut id
        instanceId - dossier instance id
        resultFlags - result flags
        detailFlags - detail flags
        shortcutCacheInfoFlag - shortcut cache info flag
        bookmarkId - bookmark id
        Returns:
        Throws:
        MSTRWebAPIException

      • getDossierShortcutCacheInfoJsonResult

        java.lang.String getDossierShortcutCacheInfoJsonResult​(java.lang.String sessionID,
                                                       int cacheType,
                                                       java.lang.String shortcutId,
                                                       java.lang.String instanceId,
                                                       java.lang.Integer resultFlags,
                                                       java.lang.Integer detailFlags,
                                                       java.lang.Integer shortcutCacheInfoFlag,
                                                       java.lang.String bookmarkId,
                                                       java.lang.String applicationId)
                                                throws MSTRWebAPIException
        Get the cache info include definition cache and data cache for a dossier shortcut Internal used only
        Parameters:
        sessionID - project session id
        cacheType - EnumDSSExportFormat - Flag to indicate export format. Now only support DssExportFormatFlash = 7
        shortcutId - dossier shortcut id
        instanceId - dossier instance id
        resultFlags - result flags
        detailFlags - detail flags
        shortcutCacheInfoFlag - shortcut cache info flag
        bookmarkId - bookmark id
        applicationId - application id
        Returns:
        Throws:
        MSTRWebAPIException