Interface IReportRequest

interface IReportRequest {
    compositionTemplates?: {
        senseImageTemplate: {
            appId: string;
            selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
            selectionsByState?: {};
            selectionsByStateDef?: string;
            visualization?: IVisualization;
        };
        senseSheetTemplate: {
            appId: string;
            selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
            selectionsByState?: {};
            selectionsByStateDef?: string;
            sheet: ISheet;
        };
        type: string;
    }[];
    definitions?: {};
    meta?: {
        exportDeadline: string;
        outputTtl: string;
    };
    output?: {
        callBackAction?: ICallbackAction;
        excelOutput?: IExcelOutput;
        imageOutput?: IImageOutput;
        outputId: string;
        pdfCompositionOutput?: {
            pdfOutput: IPDFOutput[];
            properties: IDocProperties;
        };
        pdfOutput?: IPDFOutput;
        pptxCompositionOutput?: {
            pdfOutput: IPptxOutput[];
            properties: IDocProperties;
        };
        pptxOutput?: IPptxOutput;
        type: "image" | "jsondata" | "pdf" | "xlsx" | "pdfcomposition" | "excel" | "pptx" | "pptxcomposition" | "csv";
    };
    senseImageTemplate?: {
        appId: string;
        selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
        selectionsByState?: {};
        selectionsByStateDef?: string;
        visualization: IVisualization;
    };
    senseSheetTemplate?: {
        appId: string;
        selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
        selectionsByState?: {};
        selectionsByStateDef?: string;
        sheet: ISheet;
    };
    type: string;
}

Properties

compositionTemplates? definitions? meta? output? senseImageTemplate? senseSheetTemplate? type

Properties

Optional compositionTemplates

compositionTemplates?: {
    senseImageTemplate: {
        appId: string;
        selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
        selectionsByState?: {};
        selectionsByStateDef?: string;
        visualization?: IVisualization;
    };
    senseSheetTemplate: {
        appId: string;
        selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
        selectionsByState?: {};
        selectionsByStateDef?: string;
        sheet: ISheet;
    };
    type: string;
}[]

Composition of senseSheetTemplate and/or senseImageTemplate templates

Type declaration

  • senseImageTemplate: {
        appId: string;
        selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
        selectionsByState?: {};
        selectionsByStateDef?: string;
        visualization?: IVisualization;
    }

    Used to export a single visualization as pdf or png

    • appId: string
    • Optional selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails"

      default='ignoreErrorsNoDetails

    • Optional selectionsByState?: {}

      Map of selections to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000

      • Optional selectionsByStateDef?: string

        The definition ID referring to a selectionsByState definition declared in definitions

      • Optional visualization?: IVisualization
    • senseSheetTemplate: {
          appId: string;
          selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
          selectionsByState?: {};
          selectionsByStateDef?: string;
          sheet: ISheet;
      }

      Used to export a sheet as pdf

      • appId: string
      • Optional selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails"

        default='ignoreErrorsNoDetails

      • Optional selectionsByState?: {}

        Map of selections to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000

        • Optional selectionsByStateDef?: string

          The definition ID referring to a selectionsByState definition declared in definitions

        • sheet: ISheet

          It refers to the Sense Sheet to be exported. Note that if widthPx and heightPx are not specified, default values will be applied depending on the actual size and layout properties of the Sense Sheet object.

      • type: string

        Template type and version using semantic versioning. It must have the following name convention, dashed-separated-template-name-MAJOR.MINOR

        Enum:

        • sense-image-1.0
        • sense-sheet-1.0

      Optional definitions

      definitions?: {}

      Definitions of common properties that are shared between templates, e.g. selectionsByState can be the same for all templates within a composition of templates.

      Type declaration

        Optional meta

        meta?: {
            exportDeadline: string;
            outputTtl: string;
        }

        Define the request metadata. It includes priority, deadline and future settings on execution policy of the request

        Type declaration

        • exportDeadline: string

          The maximum interval, starting from the time the API request is received, within which a report must be produced, past this interval the report generation fails. The default value is 10 minutes, the maximum allowed value is 2 hours

          iso8601

        • outputTtl: string

          Time to live of the final result artifacts in ISO8601 duration format. After that duration the request and underlying output files will not be guaranteed to be available. Default is 1 hour

          iso8601

        Optional output

        output?: {
            callBackAction?: ICallbackAction;
            excelOutput?: IExcelOutput;
            imageOutput?: IImageOutput;
            outputId: string;
            pdfCompositionOutput?: {
                pdfOutput: IPDFOutput[];
                properties: IDocProperties;
            };
            pdfOutput?: IPDFOutput;
            pptxCompositionOutput?: {
                pdfOutput: IPptxOutput[];
                properties: IDocProperties;
            };
            pptxOutput?: IPptxOutput;
            type: "image" | "jsondata" | "pdf" | "xlsx" | "pdfcomposition" | "excel" | "pptx" | "pptxcomposition" | "csv";
        }

        Type declaration

        • Optional callBackAction?: ICallbackAction

          The callback to be performed once the report is done

        • Optional excelOutput?: IExcelOutput

          Output to be used to export a excel template

        • Optional imageOutput?: IImageOutput

          Output to be used to export a single visualization as image

        • outputId: string

          The output identifier which uniquely identifies an output (PDF, image etc.) within the same request. It does not need to be a GUID. No spaces and colons are allowed in the outputId string.

        • Optional pdfCompositionOutput?: {
              pdfOutput: IPDFOutput[];
              properties: IDocProperties;
          }

          Output to be used to export a composition of templates as pdf

          • pdfOutput: IPDFOutput[]

            The ordered list of PDF outputs, the number must match the composable templates

          • properties: IDocProperties

            Properties of the document. In case of multiple composition, only properties specified in the composition output are taken and the ones specified in each output item are ignored

        • Optional pdfOutput?: IPDFOutput

          Output to be used to export a single visualization or a sheet as pdf

        • Optional pptxCompositionOutput?: {
              pdfOutput: IPptxOutput[];
              properties: IDocProperties;
          }
          • pdfOutput: IPptxOutput[]

            Output to be used to export a single visualization or a sheet as PowerPoint presentation

          • properties: IDocProperties

            Properties of the document. In case of multiple composition, only properties specified in the composition output are taken and the ones specified in each output item are ignored

        • Optional pptxOutput?: IPptxOutput

          Output to be used to export a single visualization or a sheet as PowerPoint presentation

        • type: "image" | "jsondata" | "pdf" | "xlsx" | "pdfcomposition" | "excel" | "pptx" | "pptxcomposition" | "csv"

          Each template type supports specific output types:

          • composition-1.0 supports only pdfcomposition and pptxcomposition output types
          • excel-1.0 supports only excel output type
          • sense-image-1.0 supports pdf and image output types
          • sense-sheet-1.0 supports only pdf output type

          Each output type requires a specific output to be provided:

          • excel requires excelOutput to be set
          • pdfcomposition requires pdfCompositionOutput to be set
          • pptxcomposition requires pptxCompositionOutput to be set
          • pdf requires pdfOutput to be set
          • image requires imageOutput to be set
          • csv doesn't have csv output.

        Optional senseImageTemplate

        senseImageTemplate?: {
            appId: string;
            selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
            selectionsByState?: {};
            selectionsByStateDef?: string;
            visualization: IVisualization;
        }

        Type declaration

        • appId: string
        • Optional selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails"

          default='ignoreErrorsNoDetails

        • Optional selectionsByState?: {}

          Map of selections to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000

          • Optional selectionsByStateDef?: string

            The definition ID referring to a selectionsByState definition declared in definitions

          • visualization: IVisualization

          Optional senseSheetTemplate

          senseSheetTemplate?: {
              appId: string;
              selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
              selectionsByState?: {};
              selectionsByStateDef?: string;
              sheet: ISheet;
          }

          Used to export a sheet as pdf

          Type declaration

          • appId: string
          • Optional selectionStrategy?: "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails"

            default='ignoreErrorsNoDetails

          • Optional selectionsByState?: {}

            Map of selections to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000

            • Optional selectionsByStateDef?: string

              The definition ID referring to a selectionsByState definition declared in definitions

            • sheet: ISheet

            type

            type: string

            Template type and version using semantic versioning. It must have the following name convention: dashed-separated-template-name-MAJOR.MINOR. Please note that sense-story-x.0, sense-excel-template-1.0, sense-data-x.0 and qv-data-x.0 are only for internal use.

            Each type requires a specific template to be provided:

            • composition-1.0 requires compositionTemplates to be set
            • sense-excel-template-1.0 requires senseExcelTemplate to be set
            • sense-image-1.0 requires senseImageTemplate to be set
            • sense-sheet-1.0 requires senseSheetTemplate to be set

            Each template type supports specific output types:

            • composition-1.0 supports only pdf composition output type
            • sense-excel-template-1.0 supports only excel output type
            • sense-image-1.0 supports pdf and png output types
            • sense-sheet-1.0 supports only pdf output type

            Enum:

            • composition-1.0
            • sense-image-1.0
            • sense-data-1.0
            • sense-sheet-1.0
            • sense-story-1.0
            • qv-data-1.0
            • qv-data-2.0
            • sense-excel-template-1.0

            Settings

            Member Visibility

            Theme

            On This Page