Represents a continous session for aynchronous and secondary requests
The storeID of the conversation object stored in CM
The async status, can be either WORKING or COMPLETE
Defines a filter
Defines a burst type
Defines how a version is selected
The version type. Can be NEW/LATEST/VERSION_NAME/NO_DATA/LIMITED_DATA
Optionally a searchPath to the version object can be specified, in place of the versionName.
The type of resource, such as path, report, conversationID or metrics
The ID of the resource
An ID where the prompt answers will be stored
Occurs when an error prevents the request from being fulfilled
A descriptive message about the error that occured
Additional trace data, if available
Occurs when prompt answers are required before the request can be fulfilled
A descriptive message of the the error that occured
A URL to provide HTML prompting
Occurs when authentication is required before the request can be fulfilled
A descriptive message about the error that occured
Enumeration of the valid source types.
A metrics manager resource
A conversation resource that is stored in CM for async and secondary requests
A resource that is referenced by its simplified path
A resource that is referenced by its storeID
A resource that is referenced by its searchPath
Enumerations for version specification types.
NEW - run report to obtain new content (instead of a stored version). This is the default
LATEST -retrieve the latest stored version. If none exists, run the report to obtain new content.
VERSION_NAME -retrieve the stored version, with the name specified.
Enumeration of the valid directions.
Drills up to a higher level of granularity
Drills down to a lower level of granularity
If true, include logical page breaks in the
output
Placeholder for future extensions
When present and set to true generated URLs will be relative ones
When present and set to true generated URLs will use the Gateway URI from IBM Cognos Configuration
When present and set to true images will be embedded as data
XMLEncoded data which contains the Viewer's state
When present and set to false, hidden objects will not be returned. Default: true
Runs a report interactively (if supported), retrieving the output page by page.
If true, include layout elements in the output: layoutBlock, layoutTable, Singleton, and Widget. For reportData requests, the default is false. For pagedReportData requests, the default is true.
When present and set to true generated URLs will be relative ones
When present and set to true generated URLs will use the Gateway URI from IBM Cognos Configuration
When present and set to true images will be embedded as data
XMLEncoded data which contains the Viewer state
Retrieves a URL to display the resource in Cognos 8
When present and set to true generated URLs will be relative ones
When present and set to true generated URLs will use the Gateway URI from IBM Cognos Configuration
The response to the getCognosURL command
Secondary request to drill down further into a resource
The contextId related to the object being drilled on
The direction to drill, up or down
Releases a session so that no further requests can be made
The response to the release command
Retrieves a URL to Cognos 8 to fulfill prompt answers, along with a promptID that can be used in the getPromptAnswers command
The ID of the resource, such as a report StoreID
When present and set to true generated URLs will be relative ones
When present and set to true generated URLs will use the Gateway URI from IBM Cognos Configuration
The response to the getPromptPage command
Used after the getPromptPage request. Retrieves the prompt answers associated with the prompt ID
The response to the getPromptAnswers command
For asynchronous methods, used to poll the server to get the response.
The response to the getOutput command
This needs to be a complexType so that it can coexist with 8.4 OEM CMS
Used in conjunction with the collectParameterValues command. For Tree prompts, fetches the next level of children for a specified node
Deprecated. Use a session object instead
The response to the getTreePromptNode request
Represents a parent node
An array of promptvalues
An array of PromptValues
Represents a Prompt Value (i.e an answer to a prompt)
The name of the prompt parameter
The value(s) of the prompt answer
A simple prompt value
A range prompt value
Deprecated - use sval: Indicates where this answer is inclusive in the prompt expression
The use value of the prompt
The optional display value for the prompt
The keywords you are searching on
The parameter that the search is associated with
The ID of the PSearchAndSelect prompt control
Perform a case insensitive search. Defaults to true
If true, then the results must start with the first keyword and contain the remaining keywords. If matchAnywhere is also true, then the search must contain all the keywords in any order
If true, then the result must contain any of the key words. If both this and matchAll are false, then the search result includes anything that starts with any of the key words
If true, include layout elements in the output: layoutBlock, layoutTable, Singleton, and Widget. For reportData requests, the default is false. For pagedReportData and reportPrompts requests, the default is true.
Maximum number of rows to retrieve for an object
The version of the report object requested. (May also be a request for a new run).
Allows selection of a specific burst output for a report version (by specifying a burstKey and/or burstId
Filter definitions to apply to the output
Deprecated - Use reportPrompts: Gets a prompt description
Used if there are multiple promp pages. The response to this request will contain a conversation ID, which must be passed into the the next DescribePromptsRequest to fetch the second page.
If true, indicates that the current page should be repromtped instead of going to the next page. Used when a prompt description has the attribute autoSubmit=true
The answers from previous prompt pages
Response to the promptDesciption() command
Prompt Items on this page
Used for subsequent requests, such as getting the next page or search and select prompts
An array of prompt items
A prompt item
Represents a selectValue prompt, usually represented as either a list box (multi-value) or as a dropdown list (single value)
Represents a type-in prompt.
Represents a tree prompt
Represents any of the datetime prompts (date, datetime, time, and interval). Usually rendered with a calender control.
Represents a Data Source signon prompt
Represents a Search and Select promp
A text box prompt
Name of the prompt value to be filled.
True if this is a multi-value prompt.
True if this is a range prompt. Two text box UI elements should be rendered by the client.
True if this prompt must be filled in to run the report.
True if this prompt should be submitted to the server immediately if the value changes
If available, the display name of the column that is being prompted on
A list box prompt
Name of the prompt value to be filled
True if this is a multi-value prompt
True if this is a range prompt. Two list box UI elements should be rendered by the client.
True if this prompt must be filled in to run the report.
True if this prompt should be submitted to the server immediately if the value changes
If available, the display name of the column that is being prompted on
A Date/Time prompt
Name of the prompt value to be filled.
True if this is a multi-value prompt
True if this is a range prompt.
True if this prompt must be filled in to run the report.
Type of prompt (date, time, interval, etc.)
True if this prompt should be submitted to the server immediately if the value changes
Type of calendar to use.
Display seconds.
Display milliseconds.
first date that can be selected.
last date that can be selected.
If available, the display name of the column that is being prompted on
A Tree prompt
True if this prompt should be submitted to the server immediately if the value changes
A Search and Select prompt
Name of the prompt value to be filled
True if this is a multi-value prompt
True if this is a range prompt. Two list box UI elements should be rendered by the client.
True if this prompt must be filled in to run the report.
True if this prompt should be submitted to the server immediately if the value changes
If available, the display name of the column that is being prompted on
A Data source prompts
Data source connection type
Data source signon type
Date Time Value
Type of Date Time Value
The format of the output. If not defined, the output is returned as objects
if true do not include pages in filter result
Runs a report interactively (if supported), retrieving the provider output format.
XMLEncoded data which contains the Viewer's state
The response to the getOutputFormat request
Return list of formats supported by specific report.
The response to wchich contains list of supported output formats for the specific report
List of output formats supported by the specific report
A name of the outputFormat supported by the report specified