Options

Options enable you to provide further detail about a REST command. The options allowed vary depend on the resource type.

drill_through_parameter
Specifies the name and value of a drill through parameter used to run a drill through report. The name of the parameter is the name of the drill through parameter. See Drilling through to another report.
async
Specifies whether the report will be run synchronously or asynchronously. The possible values are shown here. The default value is AUTO.
burstID
If the value of version is VERSION_NAME, this option can be used to provide a burstId value.
burstKey
If the value of version is VERSION_NAME, this option can be used to provide a burstKey value.
contextId
Specifies the ctx item to drill up or down on.
direction
Specifies the drill direction in a report. Its value is one of the values of the direction element.
drillthroughurls
Specifies whether HTML output contains drill-through information. The default value is false.
drillurls
Specifies whether HTML output contains drill-up and drill-down information. The default value is false.
eltype
Specifies which element of a report part to return in an ATOM feed.
embedImages
Specifies whether images that are included in HTML output are expressed as links to images on the IBM® Cognos® Analytics server or are embedded as data in the HTML output. The default value is false.
excludePage
Specifies that when the selection option is being used to select a report part, report pages are not considered. The default value is false.
fmt
Specifies the format of the returned output.
height
Specifies the height of the image returned when using the Image output format (fmt). The default value provides an output that is approximately the same size as when the report is viewed in IBM Cognos Viewer.
includeLayout
Specifies whether the output should include all formatting elements or only a subset of them. If the value of this option is false, then the following layout elements are not included in the report output, although report elements inside these elements are returned:
includePageBreaks
Specifies whether the output should be returned as one page or should be separated into pages as in Report Viewer. The default value is false.
inlineStyles
Specifies where style information in HTMLFragment output is located.
mtchAll
Specifies whether the search results returned match all of the search words entered. The default value is false.
mtchAny
Specifies whether the search results contain or start with the keywords. The default value is false.
nocase
Specifies whether the search is case sensitive or case insensitive. The default value is true.
pname
Specifies the report parameter to search on.
p_parameter
Specifies the name and values of a prompt parameter. The values used are the useValue elements of a GetPromptAnswersResponse response element. For example, p_P_Year=[Promotion].[Time].[Time].[Year]->[Time].[2005]. (See Running a report with prompts.)
rowLimit
Specifies the number of rows of data to be returned. For example, rowLimit=20.
saveOutput
Specifies that a copy of the report output is to be saved in the Content Store. For example, saveOutput=true.
selection
Specifies that only specific report elements is to be returned. For example, selection=List1.
srchVal
Specifies the keywords to search on.
swsID
Specifies the ID of the prompt.
useRelativeURL
When 1, the URL returned from the IBM Cognos Analytics server will be based on the external gateway URI and not on the internal dispatcher URI.
v
Specifies which version of the layout data (LDX) schema to use. The default value is 2.
version
Specifies the version of the report to retrieve. Its value is one of the values of the versionType element.
versionID
If the value of version is VERSION_NAME, this option must be used to provide a versionName value.
width
Specifies the width of the image returned when using the Image output format (fmt). The default value provides an output that is approximately the same size as when the report is viewed in IBM Cognos Viewer.
xmlData
Specifies other request parameters in XML format.
xpath
Specifies a location of the report output as an XPath 2.0 expression. The XPath expression is relative to the layoutDataXML representation of the report output.

Parent topic: REST interface reference