Output formats

You can choose to retrieve report information through the IBM® Cognos® Mashup Service in a number of different formats, giving you maximum flexibility to choose the type of output you need, depending on how you are going to process the data.

When writing applications that consume these formats, you should not assume that the outputs produced by the Mashup Service will not change over time. Although the outputs will always conform to the specifications described, the actual outputs returned may vary with new releases of this product.

Layout Data (LDX)

Layout Data (LDX) is an XML format, based on the Layout Data Schema Reference, that is an abstraction of rendered IBM Cognos content. LDX is a suitable output if you are writing a generic application for use with any IBM Cognos resource.

See Understanding the Layout Data format for a detailed description of this format.

Simple format

Simple format is an XML format that is less complex than the LDX format. This format is suitable for use when you are writing a report-specific application. This format is deprecated and will be removed in a future release of this product.

See Understanding the Simple format for a detailed description of this format.

HTML

Requesting a report output in HTML format returns a complete Web page containing the requested output. An inline stylesheet in the head element contains style information. Use this format when you want to display the output as a Web page without any additional processing.

The following features of a report rendered in IBM Cognos Viewer are not supported by the Mashup Service HTML output:

  • drill up and down links
  • tooltips

HTML fragment

Requesting a report output in HTML Fragment format returns a portion of a Web page containing the requested output. Style information is included within the elements in the fragment. Use this format when you want to add the output to a Web page without any additional processing.

The report output is returned as a div root element. This element contains child div elements that contain the report parts as HTML.

The limitation regarding HTML output also apply to this form of output.

JavaScript Object Notation

JavaScript Object Notation (JSON) is a lightweight data interchange notation that is easy for programs to parse. It is suitable for use in programming environments where XML processing is not convenient.

The JSON output contains the same information as the LDX output.

DataSet

DataSet format is a simplified XML format that contains only the report data without any formatting information.

See Understanding the DataSet format for a detailed description of this format.

DataSetAtom

DataSetAtom format consists of DataSet output in an ATOM wrapper.

DataSetJSON

DataSetJSON format consists of DataSet output in n JSON wrapper.

Image

Image format returns the report output as a portable network graphic (.png) image.