The storeID of the conversation object stored in CM
The async status, can be either WORKING or COMPLETE
A code that specifies whether the response succesed or failed.
A message that explains the details of the error.
Contains status information for the response.
Enumerations for Response Format
Enumerations for Response Status
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
Logs into IBM Cognos 8
An XML Crendential object. See the IBM Cognos 8 SDK guide for details on the credential specification.
Response to the login request
Logout of all namespaces
Response to the logoutAll request
Uploads a MS Office file to Cognos Connection
Search path to the folder to publish to
Name of the document
A description of the document
A screen tip to display for this item in Cognos Connection
Type of file
Base64 encoded file data
Gets a MS Office file published to Cognos Connection.
The path to the office document in CC.
Respone to the DownloadFile request
The file in Base64 coded form. Only exists if the request pointed to a valid Office document
Used to request the report object structure
searchPath to the report
The type of resource, such as path, report, conversationID or metrics
When present and set to true generated URLs will be relative ones
Async result of a GetReportInfo request.
Retrieves the report content
The searchPath to the object
Maximum number of rows to retrieve
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
When present and set to true generated URLs will be relative ones
Aynsc output of the getReportContent request.
Retrieves Content using the saved prompt answers specified by promptID
The searchPath to the object
Maximum number of rows to retrieve
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
The id to the prompt answers in the content store
When present and set to true generated URLs will be relative ones
Async Output of the GetPromptsAndContent request
The source ID of the request
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.
The answers from previous prompt pages
Prompt Items on this page
If there are additonal prompt pages, this ID must be used to continue the next DescribePrompts request.
Prompt Items on this page
Used for subsequent requests, such as getting the next page or search and select prompts
Retrieves saved prompt answers from the current user session in Content Manager
ID of the prompt location in CM
Response to the GetPrompts request
An array of prompt values
Saves prompt answers to the Content Manager user session
Updates a list of report element IDs with their new format
searchPath of the report to which these IDs belong.
List of old format ids to be converted to new format.
When present and set to true generated URLs will be relative ones
Aynsc output of the updateIDs request.
Old ID value passed in
New ID value foudn that matches. Will be empty if not found, or if found, but the new element has no new format ID.
True if the passed in "old" ID was found.
Performs a drill operation and retrieves content
The contextId related to the object being drilled on
The identifier of the conversation to identify the report state that is to be drilled on.
The direction to drill, up or down
The ID of the resource, such as a report StoreID
This element encapsulates all Async Output responses
This object is a container for async output
Required by AsyncToolkit
Required by AsyncToolkit
Container for async request types
Simple enumeration for async status. These values are not extensible
Contains the structure of a report.
The metadata structure of the report
The layout structure of the report
An array of MetaReportElements. Each meta element corresponds to a ReportElement in the Content Model schema.
Document header elements
Document body elements
Document footer elements
Preferred number of colums, if the data can fit within it
Preferred number of rows, if the data can fit within it
The items to be repeated in each table cell
This represents a conditional block section. This is essentially a placeholder element which will be replaced by the elements contained within one of the conditionalResult sections in the actual report data
Each conditionalResult indicates a set of elements that might appear in the data in this position.
The name of the prompt parameter
The value(s) of the prompt answer
Simple prompt answer (i.e. single value)
A range prompt answer. May include a start and/or and end value, depending on the type of range prompt
Never used.
Indicates where this answer is inclusive in the prompt expression
The use value of the prompt
The optional display value for the prompt
Optionally a searchPath to the version object can be specified, in place of the versionName.
A Meta representation of the document object.
Meta representation of the document pages
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
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.
If available, the display name of the column that is being prompted on
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.
A list of use-display value pairs
If available, the display name of the column that is being prompted on
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.)
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
Enumerations for File Type
The response to the promptPage request
A URL that provides an HTML prompting UI
A conversation ID where the prompt answers will be stored when the prompting UI has finished it's task. Pass this ID into the promptAnswers method to retrive the prompt answers
A list of prompt answers for the request
Used to perform searching for search and select prompts. You must have a conversationID for this operation to succeed.
Standard error response
A description of the error that occured
Response for cancel and release methods
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 cm storeID
A resource that is referenced by its report searchPath
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
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.
If available, the display name of the column that is being prompted on
A list of use-display value pairs
The type of resource, such as path, report, conversationID or metrics