ReportRef Structure

Use the ReportRef structure to reference an analysis.

Use the ReportRef structure in one of the following ways to reference an analysis:

  • The location of the analysis in the catalog.

  • The ReportDef object that defines the analysis. This field should always be null.

  • The XML that defines the analysis.

    Note:

    Only one of the fields in ReportRef should be populated.

    The ReportRef structure is common to all web services.

ReportRef Structure Fields

Fields Description

String reportPath

Specifies a string value that provides the path to the analysis in the catalog. For example, /users/jchan/analyses/.

String reportXML

Specifies a string value that contains the XML that defines the analysis.