Reports

Reports are downloadable assets generated from data in analytics applications.

Download OpenAPI spec

Queue a new report request generation.

Facts

Rate limit Special (10 requests per minute)

Request Body

Required

Definition of the report request. Please note that sense-powerpoint-template-1.0, sense-word-template-1.0, sense-story-x.0 and qv-data-x.0 types are only for internal use.

Each report request 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
  • sense-data-1.0 requires senseDataTemplate to be set
  • sense-pixel-perfect-template-1.0 requires sensePixelPerfectTemplate to be set
  • sense-html-template-1.0 requires senseHtmlTemplate to be set
  • sense-powerpoint-template-1.0 requires sensePowerPointTemplate to be set
  • sense-word-template-1.0 requires senseWordTemplate to be set

Each template type supports specific output types:

  • composition-1.0 supports only pdfcomposition and pptxcomposition output types
  • sense-excel-template-1.0 supports excel and pdf output type
  • sense-image-1.0 supports pdf, pptx and image output types
  • sense-sheet-1.0 supports pdf and pptx output type
  • sense-data-1.0 supports xlsx output type
  • sense-pixel-perfect-template-1.0 supports pdf output types
  • sense-html-template-1.0 supports html output types
  • sense-powerpoint-template-1.0 supports powerpoint and pdf output types
  • sense-word-template-1.0 supports word and pdf output types

Each output type requires a specific output to be provided:

  • pdfcomposition requires pdfCompositionOutput to be set
  • pptxcomposition requires pptxCompositionOutput to be set
  • pdf requires pdfOutput to be set
  • pptx requires pptxOutput to be set
  • image requires imageOutput to be set
  • xlsx requires xlsxOutput to be set
  • application/json object
    Show application/json properties
    • meta object

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

      Show meta properties
      • 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.

        format = "iso8601"

      • 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 4 hours. The recommended value for standard apps and exports (image, data, sheet) is 10 minutes, for larger apps or reports using composition or file based templates (Excel, PixelPerfect, HTML...) it should be set to 1 hour.

        format = "iso8601"

    • type string
      Required

      Template type and version using semantic versioning. It must have the following name convention: dashed-separated-template-name-MAJOR.MINOR. Please note that sense-powerpoint-template-1.0, sense-word-template-1.0, sense-story-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
      • sense-data-1.0 requires senseDataTemplate to be set
      • sense-pixel-perfect-template-1.0 requires sensePixelPerfectTemplate to be set
      • sense-html-template-1.0 requires senseHtmlTemplate to be set
      • sense-powerpoint-template-1.0 requires sensePowerPointTemplate to be set
      • sense-word-template-1.0 requires senseWordTemplate to be set

      Each template type supports specific output types:

      • composition-1.0 supports pdfcomposition and pptxcomposition output type
      • sense-excel-template-1.0 supports excel and pdf output type
      • sense-image-1.0 supports pdf, pptx and png output types
      • sense-sheet-1.0 supports pdf, pptx output type
      • sense-data-1.0 supports xlsx output type
      • sense-pixel-perfect-template-1.0 supports pdf output types
      • sense-html-template-1.0 supports html output types
      • sense-powerpoint-template-1.0 supports powerpoint and pdf output types
      • sense-word-template-1.0 supports word and pdf output types

      Each output type requires a specific output to be provided:

      • pdfcomposition requires pdfCompositionOutput to be set
      • pptxcomposition requires pptxCompositionOutput to be set
      • pdf requires pdfOutput to be set
      • pptx requires pptxOutput to be set
      • image requires imageOutput to be set
      • xlsx requires xlsxOutput to be set

      Can be one of: "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""sense-pixel-perfect-template-1.0""sense-html-template-1.0""sense-powerpoint-template-1.0""sense-word-template-1.0"

    • output object
      Required
      Show output properties
      • type string
        Required

        The generated report type.

        Each template type supports specific output types:

        • composition-1.0 supports only pdfcomposition and pptxcomposition output types
        • sense-excel-template-1.0 supports only excel and pdf output type
        • sense-pixel-perfect-template-1.0 supports only pdf output type
        • sense-html-template-1.0 supports only html output type
        • sense-powerpoint-template-1.0 supports powerpoint and pdf output types
        • sense-word-template-1.0 supports word and pdf output types
        • sense-image-1.0 supports pdf, pptx and image output types
        • sense-sheet-1.0 supports pdf and pptx output type
        • sense-data-1.0 supports xlsx 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
        • pptx requires pptxOutput to be set
        • image requires imageOutput to be set
        • csv doesn't have csv output
        • xlsx requires xlsxOutput to be set

        Can be one of: "image""pdf""xlsx""jsondata""pdfcomposition""excel""pptx""pptxcomposition""csv""cycle""html""powerpoint""word"

      • outputId string
        Required

        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.

        maxLength = 1000

      • pdfOutput object

        Output to be used to export a single visualization, a sheet, Sense Excel template as pdf. For Sense Excel template (sense-excel-template-1.0) no properties are needed, any property specified has no effect.

        Show pdfOutput properties
        • size string

          Size of the pdf page.

          Can be one of: "A1""A2""A3""A4""A5""A6""Letter""Legal""Tabloid"

          default = "A4"

        • align object

          Content alignment.

          Show align properties
          • vertical string

            Can be one of: "top""middle""bottom"

            default = "top"

          • horizontal string

            Can be one of: "left""center""right"

            default = "left"

        • properties object

          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.

          Show properties properties
          • title string

            maxLength = 10000

          • author string

            maxLength = 10000

          • subject string

            maxLength = 10000

        • resizeData object

          The area where the object (eg. sheet, chart) is printed. Required in case of "fit" resizeType.

          Show resizeData properties
          • fit string

            The size of the area in the following format "{width}{cm|mm}x{height}{cm|mm}" (e.g. "297mmx210mm"). Please remember that PDF page orientation (landscape or portrait) should match the width and height set for this field (eg. A4 landscape is "297mmx210mm", A4 portrait is "210mmx287mm"). Note that the minimum printable area is 1.5cmx1.5cm (corresponding to 0.6x0.6 inches at 96 DPI).
        • resizeType string

          The type of resize to be performed:

          • none is used to export a visualization, sheet or story as is (e.g. normal size), regardless of its size. This may result in cropping.
          • autofit automatically fits the visualization, sheet or story into the output size (i.e. A4, A3 etc.). Any provided resizeData parameter will be ignored for this configuration.
          • fit fits the visualization, sheet or story into the area specified in resizeData. The content will be rescaled to fit in that area.

          Can be one of: "none""autofit""fit"

          default = "none"

        • orientation string

          P for portrait, L for landscape and A for auto-detect. Auto-detect sets the orientation depending on the content width and height proportions: if content width > height the orientation is automatically set to landscape, portrait otherwise.

          Can be one of: "P""L""A"

          default = "P"

        • imageRenderingDpi number

          This value is used for rendered images only, set to a default of 300 dpi.

          maximum = 1000, default = 300, format = int32, default = 300

      • pptxOutput object

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

        Show pptxOutput properties
        • size string

          Size of the PowerPoint slide:

          • Widescreen: 960x540
          • OnScreen: 720x540
          • OnScreen16x9: 720x405
          • OnScreen16x10: 720x450

          Can be one of: "Widescreen""OnScreen""OnScreen16x9""OnScreen16x10"

          default = "Widescreen"

        • properties object

          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.

          Show properties properties
          • title string

            maxLength = 10000

          • author string

            maxLength = 10000

          • subject string

            maxLength = 10000

        • resizeType string

          The type of resize to be performed. Autofit automatically fits the visualization, sheet or story into the output size (i.e. Widescreen, OnScreen etc.).

          Can be one of: "autofit"

          default = "autofit"

        • orientation string

          L for landscape, P for portrait and A for auto-detect. Auto-detect sets landscape, the default PowerPoint orientation.

          Can be one of: "L""P""A"

          default = "L"

        • imageRenderingDpi number

          This value is used for rendered images only, set to a default of 300 dpi.

          maximum = 1000, default = 300, format = int32, default = 300

      • cycleOutput object
        Show cycleOutput properties
        • type string
          Required

          Can be one of: "excel""pdf""html""powerpoint""word"

        • pdfOutput object

          Output to be used to export a single visualization, a sheet, Sense Excel template as pdf. For Sense Excel template (sense-excel-template-1.0) no properties are needed, any property specified has no effect.

          Show pdfOutput properties
          • size string

            Size of the pdf page.

            Can be one of: "A1""A2""A3""A4""A5""A6""Letter""Legal""Tabloid"

            default = "A4"

          • align object

            Content alignment.

            Show align properties
            • vertical string

              Can be one of: "top""middle""bottom"

              default = "top"

            • horizontal string

              Can be one of: "left""center""right"

              default = "left"

          • properties object

            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.

            Show properties properties
            • title string

              maxLength = 10000

            • author string

              maxLength = 10000

            • subject string

              maxLength = 10000

          • resizeData object

            The area where the object (eg. sheet, chart) is printed. Required in case of "fit" resizeType.

            Show resizeData properties
            • fit string

              The size of the area in the following format "{width}{cm|mm}x{height}{cm|mm}" (e.g. "297mmx210mm"). Please remember that PDF page orientation (landscape or portrait) should match the width and height set for this field (eg. A4 landscape is "297mmx210mm", A4 portrait is "210mmx287mm"). Note that the minimum printable area is 1.5cmx1.5cm (corresponding to 0.6x0.6 inches at 96 DPI).
          • resizeType string

            The type of resize to be performed:

            • none is used to export a visualization, sheet or story as is (e.g. normal size), regardless of its size. This may result in cropping.
            • autofit automatically fits the visualization, sheet or story into the output size (i.e. A4, A3 etc.). Any provided resizeData parameter will be ignored for this configuration.
            • fit fits the visualization, sheet or story into the area specified in resizeData. The content will be rescaled to fit in that area.

            Can be one of: "none""autofit""fit"

            default = "none"

          • orientation string

            P for portrait, L for landscape and A for auto-detect. Auto-detect sets the orientation depending on the content width and height proportions: if content width > height the orientation is automatically set to landscape, portrait otherwise.

            Can be one of: "P""L""A"

            default = "P"

          • imageRenderingDpi number

            This value is used for rendered images only, set to a default of 300 dpi.

            maximum = 1000, default = 300, format = int32, default = 300

        • excelOutput object

          Output to be used to export an excel template.

          Show excelOutput properties
          • outFormat string

            The output format of the report to be produced.

            Can be one of: "xlsx"

            default = "xlsx"

        • namingPattern string

          not needed at initial phase

          Can be one of: "fieldValueWithUnderscore"

          default = "fieldValueWithUnderscore"

      • excelOutput object

        Output to be used to export an excel template.

        Show excelOutput properties
        • outFormat string

          The output format of the report to be produced.

          Can be one of: "xlsx"

          default = "xlsx"

      • imageOutput object

        Output to be used to export a single visualization as image.

        Show imageOutput properties
        • outDpi integer

          Image resolution in DPI (default 96 DPI).

          maximum = 1000, format = int32

        • outZoom number

          The scale factor to be applied in image scaling. A zoom greater than 5 will not be applied to the device pixel ratio which will remain fixed at 5.

          format = float

        • outFormat string

          The image format of the report to be produced.

          Can be one of: "png""jsondata"

          default = "png"

      • callBackAction object

        The callback to be performed once the report is done.

        Show callBackAction properties
        • httpRequest object

          Http callback. The provided uri will be called once the report is done.

          Show httpRequest properties
          • uri string

            URI of the request.
      • pdfCompositionOutput object

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

        Show pdfCompositionOutput properties
        • pdfOutputs array of objects

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

          Show pdfOutputs properties
          • size string

            Size of the pdf page.

            Can be one of: "A1""A2""A3""A4""A5""A6""Letter""Legal""Tabloid"

            default = "A4"

          • align object

            Content alignment.

            Show align properties
            • vertical string

              Can be one of: "top""middle""bottom"

              default = "top"

            • horizontal string

              Can be one of: "left""center""right"

              default = "left"

          • properties object

            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.

            Show properties properties
            • title string

              maxLength = 10000

            • author string

              maxLength = 10000

            • subject string

              maxLength = 10000

          • resizeData object

            The area where the object (eg. sheet, chart) is printed. Required in case of "fit" resizeType.

            Show resizeData properties
            • fit string

              The size of the area in the following format "{width}{cm|mm}x{height}{cm|mm}" (e.g. "297mmx210mm"). Please remember that PDF page orientation (landscape or portrait) should match the width and height set for this field (eg. A4 landscape is "297mmx210mm", A4 portrait is "210mmx287mm"). Note that the minimum printable area is 1.5cmx1.5cm (corresponding to 0.6x0.6 inches at 96 DPI).
          • resizeType string

            The type of resize to be performed:

            • none is used to export a visualization, sheet or story as is (e.g. normal size), regardless of its size. This may result in cropping.
            • autofit automatically fits the visualization, sheet or story into the output size (i.e. A4, A3 etc.). Any provided resizeData parameter will be ignored for this configuration.
            • fit fits the visualization, sheet or story into the area specified in resizeData. The content will be rescaled to fit in that area.

            Can be one of: "none""autofit""fit"

            default = "none"

          • orientation string

            P for portrait, L for landscape and A for auto-detect. Auto-detect sets the orientation depending on the content width and height proportions: if content width > height the orientation is automatically set to landscape, portrait otherwise.

            Can be one of: "P""L""A"

            default = "P"

          • imageRenderingDpi number

            This value is used for rendered images only, set to a default of 300 dpi.

            maximum = 1000, default = 300, format = int32, default = 300

        • properties object

          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.

          Show properties properties
          • title string

            maxLength = 10000

          • author string

            maxLength = 10000

          • subject string

            maxLength = 10000

      • pptxCompositionOutput object

        Output to be used to export a composition of templates as pptx.

        Show pptxCompositionOutput properties
        • pptxOutput object

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

          Show pptxOutput properties
          • size string

            Size of the PowerPoint slide:

            • Widescreen: 960x540
            • OnScreen: 720x540
            • OnScreen16x9: 720x405
            • OnScreen16x10: 720x450

            Can be one of: "Widescreen""OnScreen""OnScreen16x9""OnScreen16x10"

            default = "Widescreen"

          • properties object

            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.

            Show properties properties
            • title string

              maxLength = 10000

            • author string

              maxLength = 10000

            • subject string

              maxLength = 10000

          • resizeType string

            The type of resize to be performed. Autofit automatically fits the visualization, sheet or story into the output size (i.e. Widescreen, OnScreen etc.).

            Can be one of: "autofit"

            default = "autofit"

          • orientation string

            L for landscape, P for portrait and A for auto-detect. Auto-detect sets landscape, the default PowerPoint orientation.

            Can be one of: "L""P""A"

            default = "L"

          • imageRenderingDpi number

            This value is used for rendered images only, set to a default of 300 dpi.

            maximum = 1000, default = 300, format = int32, default = 300

    • definitions object

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

      Show definitions properties
      • selectionsByState object

        It maps an ID to a selectionsByState object.

        Show additional optional properties
        • object object

          A selectionsByState definition that can be shared between templates in a composition.

          Show additional optional properties
          • object[] array of objects
            Show object[] properties
            • values array of objects
              Required

              The values of the field to be selected.

              maxItems = 150000

              Show values properties
              • text string

                String value of the field value.

              • number number

                format = float64

              • isNumeric boolean

                IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
            • fieldName string
              Required

              The name of the field to be selected.

            • defaultIsNumeric boolean
              Required

              Default value that QFieldValue isNumeric property takes if missing.
    • senseDataTemplate object
      Show senseDataTemplate properties
      • id string
        Required

        Sense visualization id. Visualizations created "on the fly" are not supported.

      • appId string
        Required
      • patches array of objects

        Patches to apply to sense charts. Patches are soft properties meaning that are not persistent and they live within a session.

        maxItems = 100

        Show patches properties
        • qOp string
          Required

          Can be one of: "add""remove""replace"

        • qPath string
          Required

          Path to the property to add, remove or replace.

        • qValue string

          Corresponds to the value of the property to add or to the new value of the property to update.
      • variables array

        maxItems = 1100

      • exportOptions object
        Show exportOptions properties
        • showTitles boolean

          Show Visualization Title, SubTitle, Footnote in the artifact produced

        • showTotals boolean

          Show Visualization Totals in the artifact produced

        • showSelections boolean

          Show the Selections Applied to the Visualization in the artifact produced
      • selectionType string

        Can be one of: "selectionsByState""temporaryBookmark""persistentBookmark""temporaryBookmarkV2"

        default = "selectionsByState"

      • selectionStrategy string

        Can be one of: "failOnErrors""ignoreErrorsReturnDetails""ignoreErrorsNoDetails"

        default = "ignoreErrorsNoDetails"

      • selectionsByState object

        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.

        Show additional optional properties
        • object[] array of objects

          maxItems = 125

          Show object[] properties
          • values array of objects
            Required

            The values of the field to be selected.

            maxItems = 150000

            Show values properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • fieldName string
            Required

            The name of the field to be selected.

          • defaultIsNumeric boolean
            Required

            Default value that QFieldValue isNumeric property takes if missing.
      • persistentBookmark object
        Show persistentBookmark properties
        • id string
          Required

          Sense Persistence Bookmark id.
      • temporaryBookmarkV2 object

        The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.

        Show temporaryBookmarkV2 properties
        • id string
          Required

          Sense Temporary Bookmark id.
      • reloadTimestampMatchType string

        Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck.

        Can be one of: "noCheck""requestTimeExact"

        default = "noCheck"

    • senseHtmlTemplate object

      Used to produce reports from a template file.

      Show senseHtmlTemplate properties
      • jsOpts object

        A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. Currently only the "theme" and "language" properties are supported.

      • cycleFields array of strings

        The values of the field to be selected.

        maxItems = 3

      • selectionChain array of objects

        Array of ChainableSelection

        minItems = 1, maxItems = 50

        Show selectionChain properties
        • selectionType string
          Required

          Can be one of: "selectionFilter""persistentBookmark""temporaryBookmarkV2"

          default = "selectionFilter"

        • selectionFilter object
          Show selectionFilter properties
          • variables array

            maxItems = 1100

          • patchesById object

            A map for applying soft properties, aka patches, to specific visualization IDs within the sheet.

            Show additional optional properties
            • object[] array of objects

              Patches to apply to sense charts. Patches are soft properties meaning that are not persistent and they live within a session.

              maxItems = 100

              Show object[] properties
              • qOp string
                Required

                Can be one of: "add""remove""replace"

              • qPath string
                Required

                Path to the property to add, remove or replace.

              • qValue string

                Corresponds to the value of the property to add or to the new value of the property to update.
          • selectionsByState object

            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.

            Show additional optional properties
            • object[] array of objects

              maxItems = 125

              Show object[] properties
              • values array of objects
                Required

                The values of the field to be selected.

                maxItems = 150000

                Show values properties
                • text string

                  String value of the field value.

                • number number

                  format = float64

                • isNumeric boolean

                  IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
              • fieldName string
                Required

                The name of the field to be selected.

              • defaultIsNumeric boolean
                Required

                Default value that QFieldValue isNumeric property takes if missing.
        • persistentBookmark object
          Show persistentBookmark properties
          • id string
            Required

            Sense Persistence Bookmark id.
        • temporaryBookmarkV2 object

          The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.

          Show temporaryBookmarkV2 properties
          • id string
            Required

            Sense Temporary Bookmark id.
      • templateLocation object
        Required

        The location of the report template. Currently it can be an absolute or relative URL to a persisted report template, or to a template file saved as temporary content, as in the following examples: - https://qlikcloud.com:443/api/v1/report-templates/223940f7-3170-46b7-91ea-e0c81230adf7 - https://qlikcloud.com:443/api/v1/temp-contents/653bb4acae966r0730da15fc

        Show templateLocation properties
        • path string
          Required

          The report template location path.

        • format string

          Can be one of: "url"

          default = "url"

      • reloadTimestampMatchType string

        Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck.

        Can be one of: "noCheck""requestTimeExact"

        default = "noCheck"

    • senseWordTemplate object

      Used to produce reports from a template file.

      Show senseWordTemplate properties
      • jsOpts object

        A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. Currently only the "theme" and "language" properties are supported.

      • cycleFields array of strings

        The values of the field to be selected.

        maxItems = 3

      • selectionChain array of objects

        Array of ChainableSelection

        minItems = 1, maxItems = 50

        Show selectionChain properties
        • selectionType string
          Required

          Can be one of: "selectionFilter""persistentBookmark""temporaryBookmarkV2"

          default = "selectionFilter"

        • selectionFilter object
          Show selectionFilter properties
          • variables array

            maxItems = 1100

          • patchesById object

            A map for applying soft properties, aka patches, to specific visualization IDs within the sheet.

            Show additional optional properties
            • object[] array of objects

              Patches to apply to sense charts. Patches are soft properties meaning that are not persistent and they live within a session.

              maxItems = 100

              Show object[] properties
              • qOp string
                Required

                Can be one of: "add""remove""replace"

              • qPath string
                Required

                Path to the property to add, remove or replace.

              • qValue string

                Corresponds to the value of the property to add or to the new value of the property to update.
          • selectionsByState object

            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.

            Show additional optional properties
            • object[] array of objects

              maxItems = 125

              Show object[] properties
              • values array of objects
                Required

                The values of the field to be selected.

                maxItems = 150000

                Show values properties
                • text string

                  String value of the field value.

                • number number

                  format = float64

                • isNumeric boolean

                  IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
              • fieldName string
                Required

                The name of the field to be selected.

              • defaultIsNumeric boolean
                Required

                Default value that QFieldValue isNumeric property takes if missing.
        • persistentBookmark object
          Show persistentBookmark properties
          • id string
            Required

            Sense Persistence Bookmark id.
        • temporaryBookmarkV2 object

          The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.

          Show temporaryBookmarkV2 properties
          • id string
            Required

            Sense Temporary Bookmark id.
      • templateLocation object
        Required

        The location of the report template. Currently it can be an absolute or relative URL to a persisted report template, or to a template file saved as temporary content, as in the following examples: - https://qlikcloud.com:443/api/v1/report-templates/223940f7-3170-46b7-91ea-e0c81230adf7 - https://qlikcloud.com:443/api/v1/temp-contents/653bb4acae966r0730da15fc

        Show templateLocation properties
        • path string
          Required

          The report template location path.

        • format string

          Can be one of: "url"

          default = "url"

      • reloadTimestampMatchType string

        Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck.

        Can be one of: "noCheck""requestTimeExact"

        default = "noCheck"

    • senseExcelTemplate object

      Used to produce reports from a template file.

      Show senseExcelTemplate properties
      • jsOpts object

        A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. Currently only the "theme" and "language" properties are supported.

      • cycleFields array of strings

        The values of the field to be selected.

        maxItems = 3

      • selectionChain array of objects

        Array of ChainableSelection

        minItems = 1, maxItems = 50

        Show selectionChain properties
        • selectionType string
          Required

          Can be one of: "selectionFilter""persistentBookmark""temporaryBookmarkV2"

          default = "selectionFilter"

        • selectionFilter object
          Show selectionFilter properties
          • variables array

            maxItems = 1100

          • patchesById object

            A map for applying soft properties, aka patches, to specific visualization IDs within the sheet.

            Show additional optional properties
            • object[] array of objects

              Patches to apply to sense charts. Patches are soft properties meaning that are not persistent and they live within a session.

              maxItems = 100

              Show object[] properties
              • qOp string
                Required

                Can be one of: "add""remove""replace"

              • qPath string
                Required

                Path to the property to add, remove or replace.

              • qValue string

                Corresponds to the value of the property to add or to the new value of the property to update.
          • selectionsByState object

            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.

            Show additional optional properties
            • object[] array of objects

              maxItems = 125

              Show object[] properties
              • values array of objects
                Required

                The values of the field to be selected.

                maxItems = 150000

                Show values properties
                • text string

                  String value of the field value.

                • number number

                  format = float64

                • isNumeric boolean

                  IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
              • fieldName string
                Required

                The name of the field to be selected.

              • defaultIsNumeric boolean
                Required

                Default value that QFieldValue isNumeric property takes if missing.
        • persistentBookmark object
          Show persistentBookmark properties
          • id string
            Required

            Sense Persistence Bookmark id.
        • temporaryBookmarkV2 object

          The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.

          Show temporaryBookmarkV2 properties
          • id string
            Required

            Sense Temporary Bookmark id.
      • templateLocation object
        Required

        The location of the report template. Currently it can be an absolute or relative URL to a persisted report template, or to a template file saved as temporary content, as in the following examples: - https://qlikcloud.com:443/api/v1/report-templates/223940f7-3170-46b7-91ea-e0c81230adf7 - https://qlikcloud.com:443/api/v1/temp-contents/653bb4acae966r0730da15fc

        Show templateLocation properties
        • path string
          Required

          The report template location path.

        • format string

          Can be one of: "url"

          default = "url"

      • reloadTimestampMatchType string

        Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck.

        Can be one of: "noCheck""requestTimeExact"

        default = "noCheck"

    • senseImageTemplate object

      Used to export a single visualization as pdf, pptx or png.

      Show senseImageTemplate properties
      • appId string
        Required
      • selectionType string

        Can be one of: "selectionsByState""temporaryBookmark""persistentBookmark""temporaryBookmarkV2"

        default = "selectionsByState"

      • visualization object
        Required
        Show visualization properties
        • id string
          Required

          The sense visualization id or json definition.

        • type string

          Choose visualization to export an image of a sense chart, sessionobject for a visualization to be created on-the-fly, sheet to export a sheet as a whole image. An empty value leads to the type being inferred by its id.

          Can be one of: "visualization""sessionobject""sheet"

        • jsOpts object

          A JSON object that is passed as-is to the mashup page while rendering.

        • patches array of objects

          Soft properties, aka patches, to be applied to the visualization.

          maxItems = 100

          Show patches properties
          • qOp string
            Required

            Can be one of: "add""remove""replace"

          • qPath string
            Required

            Path to the property to add, remove or replace.

          • qValue string

            Corresponds to the value of the property to add or to the new value of the property to update.
        • widthPx number
          Required

          Width in pixels.

          minimum = 5, maximum = 4000, format = float

        • heightPx number
          Required

          Height in pixels.

          minimum = 5, maximum = 4000, format = float

      • selectionChain array of objects

        Array of ChainableSelection

        minItems = 1, maxItems = 50

        Show selectionChain properties
        • selectionType string
          Required

          Can be one of: "selectionFilter""persistentBookmark""temporaryBookmarkV2"

          default = "selectionFilter"

        • selectionFilter object
          Show selectionFilter properties
          • variables array

            maxItems = 1100

          • patchesById object

            A map for applying soft properties, aka patches, to specific visualization IDs within the sheet.

            Show additional optional properties
            • object[] array of objects

              Patches to apply to sense charts. Patches are soft properties meaning that are not persistent and they live within a session.

              maxItems = 100

              Show object[] properties
              • qOp string
                Required

                Can be one of: "add""remove""replace"

              • qPath string
                Required

                Path to the property to add, remove or replace.

              • qValue string

                Corresponds to the value of the property to add or to the new value of the property to update.
          • selectionsByState object

            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.

            Show additional optional properties
            • object[] array of objects

              maxItems = 125

              Show object[] properties
              • values array of objects
                Required

                The values of the field to be selected.

                maxItems = 150000

                Show values properties
                • text string

                  String value of the field value.

                • number number

                  format = float64

                • isNumeric boolean

                  IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
              • fieldName string
                Required

                The name of the field to be selected.

              • defaultIsNumeric boolean
                Required

                Default value that QFieldValue isNumeric property takes if missing.
        • persistentBookmark object
          Show persistentBookmark properties
          • id string
            Required

            Sense Persistence Bookmark id.
        • temporaryBookmarkV2 object

          The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.

          Show temporaryBookmarkV2 properties
          • id string
            Required

            Sense Temporary Bookmark id.
      • selectionStrategy string

        Can be one of: "failOnErrors""ignoreErrorsReturnDetails""ignoreErrorsNoDetails"

        default = "ignoreErrorsNoDetails"

      • selectionsByState object

        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.

        Show additional optional properties
        • object[] array of objects

          maxItems = 125

          Show object[] properties
          • values array of objects
            Required

            The values of the field to be selected.

            maxItems = 150000

            Show values properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • fieldName string
            Required

            The name of the field to be selected.

          • defaultIsNumeric boolean
            Required

            Default value that QFieldValue isNumeric property takes if missing.
      • persistentBookmark object
        Show persistentBookmark properties
        • id string
          Required

          Sense Persistence Bookmark id.
      • temporaryBookmarkV2 object

        The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.

        Show temporaryBookmarkV2 properties
        • id string
          Required

          Sense Temporary Bookmark id.
      • selectionsByStateDef string

        The definition ID referring to a selectionsByState definition declared in definitions.

      • reloadTimestampMatchType string

        Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck.

        Can be one of: "noCheck""requestTimeExact"

        default = "noCheck"

    • senseSheetTemplate object

      Used to export a sheet as pdf or pptx.

      Show senseSheetTemplate properties
      • appId string
        Required
      • sheet object
        Required

        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.

        Show sheet properties
        • id string
          Required

          The id of the sheet.

        • jsOpts object

          A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc.

        • widthPx number

          The width of the sheet in pixels. Default value is: - 1680 pixels for responsive sheet - 1120 pixels for extended sheet - same width set in sheet properties for custom sheet

          minimum = 20, maximum = 4000, format = float

        • heightPx number

          The height of the sheet in pixels. Default value is: - 1120 pixels for responsive sheet - 1680 pixels for extended sheet - same height set in sheet properties for custom sheet

          minimum = 20, maximum = 4000, format = float

        • jsOptsById object

          A map for applying jsOpts to specific visualization IDs within the sheet.

          Show additional optional properties
          • object object

            A JSON object that is passed as-is to the mashup page while rendering.
        • patchesById object

          A map for applying soft properties, aka patches, to specific visualization IDs within the sheet.

          Show additional optional properties
          • object[] array of objects

            Patches to apply to sense charts. Patches are soft properties meaning that are not persistent and they live within a session.

            maxItems = 100

            Show object[] properties
            • qOp string
              Required

              Can be one of: "add""remove""replace"

            • qPath string
              Required

              Path to the property to add, remove or replace.

            • qValue string

              Corresponds to the value of the property to add or to the new value of the property to update.
      • selectionType string

        Can be one of: "selectionsByState""temporaryBookmark""persistentBookmark""temporaryBookmarkV2"

        default = "selectionsByState"

      • selectionStrategy string

        Can be one of: "failOnErrors""ignoreErrorsReturnDetails""ignoreErrorsNoDetails"

        default = "ignoreErrorsNoDetails"

      • selectionsByState object

        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.

        Show additional optional properties
        • object[] array of objects

          maxItems = 125

          Show object[] properties
          • values array of objects
            Required

            The values of the field to be selected.

            maxItems = 150000

            Show values properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • fieldName string
            Required

            The name of the field to be selected.

          • defaultIsNumeric boolean
            Required

            Default value that QFieldValue isNumeric property takes if missing.
      • persistentBookmark object
        Show persistentBookmark properties
        • id string
          Required

          Sense Persistence Bookmark id.
      • temporaryBookmarkV2 object

        The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.

        Show temporaryBookmarkV2 properties
        • id string
          Required

          Sense Temporary Bookmark id.
      • selectionsByStateDef string

        The definition ID referring to a selectionsByState definition declared in definitions.

      • reloadTimestampMatchType string

        Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck.

        Can be one of: "noCheck""requestTimeExact"

        default = "noCheck"

    • compositionTemplates array of objects

      Composition of senseSheetTemplate and/or senseImageTemplate templates.

      minItems = 1

      Show compositionTemplates properties
      • type string
        Required

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

        Can be one of: "sense-image-1.0""sense-sheet-1.0"

      • senseImageTemplate object

        Used to export a single visualization as pdf, pptx or png.

        Show senseImageTemplate properties
        • appId string
          Required
        • selectionType string

          Can be one of: "selectionsByState""temporaryBookmark""persistentBookmark""temporaryBookmarkV2"

          default = "selectionsByState"

        • visualization object
          Required
          Show visualization properties
          • id string
            Required

            The sense visualization id or json definition.

          • type string

            Choose visualization to export an image of a sense chart, sessionobject for a visualization to be created on-the-fly, sheet to export a sheet as a whole image. An empty value leads to the type being inferred by its id.

            Can be one of: "visualization""sessionobject""sheet"

          • jsOpts object

            A JSON object that is passed as-is to the mashup page while rendering.

          • patches array of objects

            Soft properties, aka patches, to be applied to the visualization.

            maxItems = 100

            Show patches properties
            • qOp string
              Required

              Can be one of: "add""remove""replace"

            • qPath string
              Required

              Path to the property to add, remove or replace.

            • qValue string

              Corresponds to the value of the property to add or to the new value of the property to update.
          • widthPx number
            Required

            Width in pixels.

            minimum = 5, maximum = 4000, format = float

          • heightPx number
            Required

            Height in pixels.

            minimum = 5, maximum = 4000, format = float

        • selectionChain array of objects

          Array of ChainableSelection

          minItems = 1, maxItems = 50

          Show selectionChain properties
          • selectionType string
            Required

            Can be one of: "selectionFilter""persistentBookmark""temporaryBookmarkV2"

            default = "selectionFilter"

          • selectionFilter object
            Show selectionFilter properties
            • variables array

              maxItems = 1100

            • patchesById object

              A map for applying soft properties, aka patches, to specific visualization IDs within the sheet.

              Show additional optional properties
              • object[] array of objects

                Patches to apply to sense charts. Patches are soft properties meaning that are not persistent and they live within a session.

                maxItems = 100

                Show object[] properties
                • qOp string
                  Required

                  Can be one of: "add""remove""replace"

                • qPath string
                  Required

                  Path to the property to add, remove or replace.

                • qValue string

                  Corresponds to the value of the property to add or to the new value of the property to update.
            • selectionsByState object

              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.

              Show additional optional properties
              • object[] array of objects

                maxItems = 125

                Show object[] properties
                • values array of objects
                  Required

                  The values of the field to be selected.

                  maxItems = 150000

                  Show values properties
                  • text string

                    String value of the field value.

                  • number number

                    format = float64

                  • isNumeric boolean

                    IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
                • fieldName string
                  Required

                  The name of the field to be selected.

                • defaultIsNumeric boolean
                  Required

                  Default value that QFieldValue isNumeric property takes if missing.
          • persistentBookmark object
            Show persistentBookmark properties
            • id string
              Required

              Sense Persistence Bookmark id.
          • temporaryBookmarkV2 object

            The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.

            Show temporaryBookmarkV2 properties
            • id string
              Required

              Sense Temporary Bookmark id.
        • selectionStrategy string

          Can be one of: "failOnErrors""ignoreErrorsReturnDetails""ignoreErrorsNoDetails"

          default = "ignoreErrorsNoDetails"

        • selectionsByState object

          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.

          Show additional optional properties
          • object[] array of objects

            maxItems = 125

            Show object[] properties
            • values array of objects
              Required

              The values of the field to be selected.

              maxItems = 150000

              Show values properties
              • text string

                String value of the field value.

              • number number

                format = float64

              • isNumeric boolean

                IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
            • fieldName string
              Required

              The name of the field to be selected.

            • defaultIsNumeric boolean
              Required

              Default value that QFieldValue isNumeric property takes if missing.
        • persistentBookmark object
          Show persistentBookmark properties
          • id string
            Required

            Sense Persistence Bookmark id.
        • temporaryBookmarkV2 object

          The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.

          Show temporaryBookmarkV2 properties
          • id string
            Required

            Sense Temporary Bookmark id.
        • selectionsByStateDef string

          The definition ID referring to a selectionsByState definition declared in definitions.

        • reloadTimestampMatchType string

          Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck.

          Can be one of: "noCheck""requestTimeExact"

          default = "noCheck"

      • senseSheetTemplate object

        Used to export a sheet as pdf or pptx.

        Show senseSheetTemplate properties
        • appId string
          Required
        • sheet object
          Required

          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.

          Show sheet properties
          • id string
            Required

            The id of the sheet.

          • jsOpts object

            A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc.

          • widthPx number

            The width of the sheet in pixels. Default value is: - 1680 pixels for responsive sheet - 1120 pixels for extended sheet - same width set in sheet properties for custom sheet

            minimum = 20, maximum = 4000, format = float

          • heightPx number

            The height of the sheet in pixels. Default value is: - 1120 pixels for responsive sheet - 1680 pixels for extended sheet - same height set in sheet properties for custom sheet

            minimum = 20, maximum = 4000, format = float

          • jsOptsById object

            A map for applying jsOpts to specific visualization IDs within the sheet.

            Show additional optional properties
            • object object

              A JSON object that is passed as-is to the mashup page while rendering.
          • patchesById object

            A map for applying soft properties, aka patches, to specific visualization IDs within the sheet.

            Show additional optional properties
            • object[] array of objects

              Patches to apply to sense charts. Patches are soft properties meaning that are not persistent and they live within a session.

              maxItems = 100

              Show object[] properties
              • qOp string
                Required

                Can be one of: "add""remove""replace"

              • qPath string
                Required

                Path to the property to add, remove or replace.

              • qValue string

                Corresponds to the value of the property to add or to the new value of the property to update.
        • selectionType string

          Can be one of: "selectionsByState""temporaryBookmark""persistentBookmark""temporaryBookmarkV2"

          default = "selectionsByState"

        • selectionStrategy string

          Can be one of: "failOnErrors""ignoreErrorsReturnDetails""ignoreErrorsNoDetails"

          default = "ignoreErrorsNoDetails"

        • selectionsByState object

          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.

          Show additional optional properties
          • object[] array of objects

            maxItems = 125

            Show object[] properties
            • values array of objects
              Required

              The values of the field to be selected.

              maxItems = 150000

              Show values properties
              • text string

                String value of the field value.

              • number number

                format = float64

              • isNumeric boolean

                IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
            • fieldName string
              Required

              The name of the field to be selected.

            • defaultIsNumeric boolean
              Required

              Default value that QFieldValue isNumeric property takes if missing.
        • persistentBookmark object
          Show persistentBookmark properties
          • id string
            Required

            Sense Persistence Bookmark id.
        • temporaryBookmarkV2 object

          The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.

          Show temporaryBookmarkV2 properties
          • id string
            Required

            Sense Temporary Bookmark id.
        • selectionsByStateDef string

          The definition ID referring to a selectionsByState definition declared in definitions.

        • reloadTimestampMatchType string

          Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck.

          Can be one of: "noCheck""requestTimeExact"

          default = "noCheck"

    • requestCallBackAction object

      The callback to be performed once the report is done.

      Show requestCallBackAction properties
      • httpRequest object

        Http callback. The provided uri will be called once the report is done.

        Show httpRequest properties
        • uri string

          URI of the request.
    • sensePowerPointTemplate object

      Used to produce reports from a template file.

      Show sensePowerPointTemplate properties
      • jsOpts object

        A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. Currently only the "theme" and "language" properties are supported.

      • cycleFields array of strings

        The values of the field to be selected.

        maxItems = 3

      • selectionChain array of objects

        Array of ChainableSelection

        minItems = 1, maxItems = 50

        Show selectionChain properties
        • selectionType string
          Required

          Can be one of: "selectionFilter""persistentBookmark""temporaryBookmarkV2"

          default = "selectionFilter"

        • selectionFilter object
          Show selectionFilter properties
          • variables array

            maxItems = 1100

          • patchesById object

            A map for applying soft properties, aka patches, to specific visualization IDs within the sheet.

            Show additional optional properties
            • object[] array of objects

              Patches to apply to sense charts. Patches are soft properties meaning that are not persistent and they live within a session.

              maxItems = 100

              Show object[] properties
              • qOp string
                Required

                Can be one of: "add""remove""replace"

              • qPath string
                Required

                Path to the property to add, remove or replace.

              • qValue string

                Corresponds to the value of the property to add or to the new value of the property to update.
          • selectionsByState object

            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.

            Show additional optional properties
            • object[] array of objects

              maxItems = 125

              Show object[] properties
              • values array of objects
                Required

                The values of the field to be selected.

                maxItems = 150000

                Show values properties
                • text string

                  String value of the field value.

                • number number

                  format = float64

                • isNumeric boolean

                  IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
              • fieldName string
                Required

                The name of the field to be selected.

              • defaultIsNumeric boolean
                Required

                Default value that QFieldValue isNumeric property takes if missing.
        • persistentBookmark object
          Show persistentBookmark properties
          • id string
            Required

            Sense Persistence Bookmark id.
        • temporaryBookmarkV2 object

          The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.

          Show temporaryBookmarkV2 properties
          • id string
            Required

            Sense Temporary Bookmark id.
      • templateLocation object
        Required

        The location of the report template. Currently it can be an absolute or relative URL to a persisted report template, or to a template file saved as temporary content, as in the following examples: - https://qlikcloud.com:443/api/v1/report-templates/223940f7-3170-46b7-91ea-e0c81230adf7 - https://qlikcloud.com:443/api/v1/temp-contents/653bb4acae966r0730da15fc

        Show templateLocation properties
        • path string
          Required

          The report template location path.

        • format string

          Can be one of: "url"

          default = "url"

      • reloadTimestampMatchType string

        Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck.

        Can be one of: "noCheck""requestTimeExact"

        default = "noCheck"

    • sensePixelPerfectTemplate object

      Used to produce reports from a template file.

      Show sensePixelPerfectTemplate properties
      • jsOpts object

        A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. Currently only the "theme" and "language" properties are supported.

      • cycleFields array of strings

        The values of the field to be selected.

        maxItems = 3

      • selectionChain array of objects

        Array of ChainableSelection

        minItems = 1, maxItems = 50

        Show selectionChain properties
        • selectionType string
          Required

          Can be one of: "selectionFilter""persistentBookmark""temporaryBookmarkV2"

          default = "selectionFilter"

        • selectionFilter object
          Show selectionFilter properties
          • variables array

            maxItems = 1100

          • patchesById object

            A map for applying soft properties, aka patches, to specific visualization IDs within the sheet.

            Show additional optional properties
            • object[] array of objects

              Patches to apply to sense charts. Patches are soft properties meaning that are not persistent and they live within a session.

              maxItems = 100

              Show object[] properties
              • qOp string
                Required

                Can be one of: "add""remove""replace"

              • qPath string
                Required

                Path to the property to add, remove or replace.

              • qValue string

                Corresponds to the value of the property to add or to the new value of the property to update.
          • selectionsByState object

            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.

            Show additional optional properties
            • object[] array of objects

              maxItems = 125

              Show object[] properties
              • values array of objects
                Required

                The values of the field to be selected.

                maxItems = 150000

                Show values properties
                • text string

                  String value of the field value.

                • number number

                  format = float64

                • isNumeric boolean

                  IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
              • fieldName string
                Required

                The name of the field to be selected.

              • defaultIsNumeric boolean
                Required

                Default value that QFieldValue isNumeric property takes if missing.
        • persistentBookmark object
          Show persistentBookmark properties
          • id string
            Required

            Sense Persistence Bookmark id.
        • temporaryBookmarkV2 object

          The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.

          Show temporaryBookmarkV2 properties
          • id string
            Required

            Sense Temporary Bookmark id.
      • templateLocation object
        Required

        The location of the report template. Currently it can be an absolute or relative URL to a persisted report template, or to a template file saved as temporary content, as in the following examples: - https://qlikcloud.com:443/api/v1/report-templates/223940f7-3170-46b7-91ea-e0c81230adf7 - https://qlikcloud.com:443/api/v1/temp-contents/653bb4acae966r0730da15fc

        Show templateLocation properties
        • path string
          Required

          The report template location path.

        • format string

          Can be one of: "url"

          default = "url"

      • reloadTimestampMatchType string

        Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck.

        Can be one of: "noCheck""requestTimeExact"

        default = "noCheck"

Responses

202

Report request accepted.

  • application/json object
    Show application/json properties
    • message string

      A message indicating the status of the request.

    • requestId string

      The report request ID

    • outputsUrl string

      The absolute URL to get the outputs of the report request.

      format = "uri"

400

Bad request, malformed syntax, errors in params or the report request is not valid.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

401

Unauthorized, JWT invalid or not provided.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

403

Forbidden, the user does not have access rights.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

404

Not found.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

409

Conflicted request. Report aborted.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

429

Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.
POST /api/v1/reports 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.reports.createReport({
  compositionTemplates: [
    {
      senseSheetTemplate: {
        appId:
          '2451e58e-a1b9-4047-abf6-315e91d8a610',
        selectionsByStateDef: 'sel1',
        sheet: {
          id: '5ffe3801-1b6d-439d-a849-84d0748358f1',
        },
      },
      type: 'sense-sheet-1.0',
    },


    {
      senseSheetTemplate: {
        appId:
          '2451e58e-a1b9-4047-abf6-315e91d8a610',
        selectionsByStateDef: 'sel1',
        sheet: { id: 'ffrxJyA' },
      },
      type: 'sense-sheet-1.0',
    },
  ],
  definitions: {
    selectionsByState: {
      sel1: {
        $: [
          {
            fieldName: 'Region',
            values: [{ text: 'Arizona' }],
          },
        ],
      },
    },
  },
  output: {
    outputId: 'composition1',
    pdfCompositionOutput: {
      pdfOutputs: [
        {
          align: {
            horizontal: 'center',
            vertical: 'middle',
          },
          orientation: 'A',
          resizeType: 'autofit',
          size: 'A4',
        },


        {
          align: {
            horizontal: 'center',
            vertical: 'middle',
          },
          orientation: 'A',
          resizeType: 'autofit',
          size: 'A4',
        },
      ],
    },
    type: 'pdfcomposition',
  },
  type: 'composition-1.0',
})
qlik report create \
  --compositionTemplates-senseImageTemplate-appId '' \
  --compositionTemplates-senseImageTemplate-persistentBookmark-id '' \
  --compositionTemplates-senseImageTemplate-selectionChain-persistentBookmark-id '' \
  --compositionTemplates-senseImageTemplate-selectionChain-selectionFilter-patchesById-qOp '' \
  --compositionTemplates-senseImageTemplate-selectionChain-selectionFilter-patchesById-qPath '' \
  --compositionTemplates-senseImageTemplate-selectionChain-selectionFilter-selectionsByState-defaultIsNumeric  \
  --compositionTemplates-senseImageTemplate-selectionChain-selectionFilter-selectionsByState-fieldName '' \
  --compositionTemplates-senseImageTemplate-selectionChain-selectionFilter-selectionsByState-values-isNumeric  \
  --compositionTemplates-senseImageTemplate-selectionChain-selectionFilter-selectionsByState-values-number  \
  --compositionTemplates-senseImageTemplate-selectionChain-selectionFilter-selectionsByState-values-text '' \
  --compositionTemplates-senseImageTemplate-selectionChain-selectionType '' \
  --compositionTemplates-senseImageTemplate-selectionChain-temporaryBookmarkV2-id '' \
  --compositionTemplates-senseImageTemplate-selectionsByState-defaultIsNumeric  \
  --compositionTemplates-senseImageTemplate-selectionsByState-fieldName '' \
  --compositionTemplates-senseImageTemplate-selectionsByState-values-isNumeric  \
  --compositionTemplates-senseImageTemplate-selectionsByState-values-number  \
  --compositionTemplates-senseImageTemplate-selectionsByState-values-text '' \
  --compositionTemplates-senseImageTemplate-temporaryBookmarkV2-id '' \
  --compositionTemplates-senseImageTemplate-visualization-heightPx  \
  --compositionTemplates-senseImageTemplate-visualization-id '' \
  --compositionTemplates-senseImageTemplate-visualization-jsOpts  \
  --compositionTemplates-senseImageTemplate-visualization-patches-qOp '' \
  --compositionTemplates-senseImageTemplate-visualization-patches-qPath '' \
  --compositionTemplates-senseImageTemplate-visualization-patches-qValue '' \
  --compositionTemplates-senseImageTemplate-visualization-type '' \
  --compositionTemplates-senseImageTemplate-visualization-widthPx  \
  --compositionTemplates-senseSheetTemplate-appId '' \
  --compositionTemplates-senseSheetTemplate-persistentBookmark-id '' \
  --compositionTemplates-senseSheetTemplate-selectionsByState-defaultIsNumeric  \
  --compositionTemplates-senseSheetTemplate-selectionsByState-fieldName '' \
  --compositionTemplates-senseSheetTemplate-selectionsByState-values-isNumeric  \
  --compositionTemplates-senseSheetTemplate-selectionsByState-values-number  \
  --compositionTemplates-senseSheetTemplate-selectionsByState-values-text '' \
  --compositionTemplates-senseSheetTemplate-sheet-heightPx  \
  --compositionTemplates-senseSheetTemplate-sheet-id '' \
  --compositionTemplates-senseSheetTemplate-sheet-jsOpts  \
  --compositionTemplates-senseSheetTemplate-sheet-patchesById-qOp '' \
  --compositionTemplates-senseSheetTemplate-sheet-patchesById-qPath '' \
  --compositionTemplates-senseSheetTemplate-sheet-patchesById-qValue '' \
  --compositionTemplates-senseSheetTemplate-sheet-widthPx  \
  --compositionTemplates-senseSheetTemplate-temporaryBookmarkV2-id '' \
  --compositionTemplates-type '' \
  --definitions-selectionsByState-defaultIsNumeric  \
  --definitions-selectionsByState-fieldName '' \
  --definitions-selectionsByState-values-isNumeric  \
  --definitions-selectionsByState-values-number  \
  --definitions-selectionsByState-values-text '' \
  --output-callBackAction-httpRequest-uri '' \
  --output-cycleOutput-excelOutput-outFormat '' \
  --output-cycleOutput-namingPattern '' \
  --output-cycleOutput-pdfOutput-align-horizontal '' \
  --output-cycleOutput-pdfOutput-align-vertical '' \
  --output-cycleOutput-pdfOutput-imageRenderingDpi  \
  --output-cycleOutput-pdfOutput-orientation '' \
  --output-cycleOutput-pdfOutput-properties-author '' \
  --output-cycleOutput-pdfOutput-properties-subject '' \
  --output-cycleOutput-pdfOutput-properties-title '' \
  --output-cycleOutput-pdfOutput-resizeData-fit '' \
  --output-cycleOutput-pdfOutput-resizeType '' \
  --output-cycleOutput-pdfOutput-size '' \
  --output-cycleOutput-type '' \
  --output-excelOutput-outFormat '' \
  --output-imageOutput-outDpi  \
  --output-imageOutput-outFormat '' \
  --output-imageOutput-outZoom  \
  --output-outputId 'composition1' \
  --output-pdfCompositionOutput-pdfOutputs-align-horizontal '' \
  --output-pdfCompositionOutput-pdfOutputs-align-vertical '' \
  --output-pdfCompositionOutput-pdfOutputs-imageRenderingDpi  \
  --output-pdfCompositionOutput-pdfOutputs-orientation '' \
  --output-pdfCompositionOutput-pdfOutputs-properties-author '' \
  --output-pdfCompositionOutput-pdfOutputs-properties-subject '' \
  --output-pdfCompositionOutput-pdfOutputs-properties-title '' \
  --output-pdfCompositionOutput-pdfOutputs-resizeData-fit '' \
  --output-pdfCompositionOutput-pdfOutputs-resizeType '' \
  --output-pdfCompositionOutput-pdfOutputs-size '' \
  --output-pdfCompositionOutput-properties-author '' \
  --output-pdfCompositionOutput-properties-subject '' \
  --output-pdfCompositionOutput-properties-title '' \
  --output-pdfOutput-align-horizontal '' \
  --output-pdfOutput-align-vertical '' \
  --output-pdfOutput-imageRenderingDpi  \
  --output-pdfOutput-orientation '' \
  --output-pdfOutput-properties-author '' \
  --output-pdfOutput-properties-subject '' \
  --output-pdfOutput-properties-title '' \
  --output-pdfOutput-resizeData-fit '' \
  --output-pdfOutput-resizeType '' \
  --output-pdfOutput-size '' \
  --output-pptxCompositionOutput-pptxOutput-imageRenderingDpi  \
  --output-pptxCompositionOutput-pptxOutput-orientation '' \
  --output-pptxCompositionOutput-pptxOutput-properties-author '' \
  --output-pptxCompositionOutput-pptxOutput-properties-subject '' \
  --output-pptxCompositionOutput-pptxOutput-properties-title '' \
  --output-pptxCompositionOutput-pptxOutput-resizeType '' \
  --output-pptxCompositionOutput-pptxOutput-size '' \
  --output-pptxOutput-imageRenderingDpi  \
  --output-pptxOutput-orientation '' \
  --output-pptxOutput-properties-author '' \
  --output-pptxOutput-properties-subject '' \
  --output-pptxOutput-properties-title '' \
  --output-pptxOutput-resizeType '' \
  --output-pptxOutput-size '' \
  --output-type 'pdfcomposition' \
  --senseDataTemplate-appId '' \
  --senseDataTemplate-id '' \
  --senseDataTemplate-patches-qOp '' \
  --senseDataTemplate-patches-qPath '' \
  --senseDataTemplate-persistentBookmark-id '' \
  --senseDataTemplate-selectionsByState-defaultIsNumeric  \
  --senseDataTemplate-selectionsByState-fieldName '' \
  --senseDataTemplate-selectionsByState-values-isNumeric  \
  --senseDataTemplate-selectionsByState-values-number  \
  --senseDataTemplate-selectionsByState-values-text '' \
  --senseDataTemplate-temporaryBookmarkV2-id '' \
  --senseExcelTemplate-selectionChain-persistentBookmark-id '' \
  --senseExcelTemplate-selectionChain-selectionFilter-patchesById-qOp '' \
  --senseExcelTemplate-selectionChain-selectionFilter-patchesById-qPath '' \
  --senseExcelTemplate-selectionChain-selectionFilter-selectionsByState-defaultIsNumeric  \
  --senseExcelTemplate-selectionChain-selectionFilter-selectionsByState-fieldName '' \
  --senseExcelTemplate-selectionChain-selectionFilter-selectionsByState-values-isNumeric  \
  --senseExcelTemplate-selectionChain-selectionFilter-selectionsByState-values-number  \
  --senseExcelTemplate-selectionChain-selectionFilter-selectionsByState-values-text '' \
  --senseExcelTemplate-selectionChain-selectionType '' \
  --senseExcelTemplate-selectionChain-temporaryBookmarkV2-id '' \
  --senseExcelTemplate-templateLocation-format '' \
  --senseExcelTemplate-templateLocation-path '' \
  --senseHtmlTemplate-selectionChain-persistentBookmark-id '' \
  --senseHtmlTemplate-selectionChain-selectionFilter-patchesById-qOp '' \
  --senseHtmlTemplate-selectionChain-selectionFilter-patchesById-qPath '' \
  --senseHtmlTemplate-selectionChain-selectionFilter-selectionsByState-defaultIsNumeric  \
  --senseHtmlTemplate-selectionChain-selectionFilter-selectionsByState-fieldName '' \
  --senseHtmlTemplate-selectionChain-selectionFilter-selectionsByState-values-isNumeric  \
  --senseHtmlTemplate-selectionChain-selectionFilter-selectionsByState-values-number  \
  --senseHtmlTemplate-selectionChain-selectionFilter-selectionsByState-values-text '' \
  --senseHtmlTemplate-selectionChain-selectionType '' \
  --senseHtmlTemplate-selectionChain-temporaryBookmarkV2-id '' \
  --senseHtmlTemplate-templateLocation-format '' \
  --senseHtmlTemplate-templateLocation-path '' \
  --senseImageTemplate-appId '' \
  --senseImageTemplate-persistentBookmark-id '' \
  --senseImageTemplate-selectionChain-persistentBookmark-id '' \
  --senseImageTemplate-selectionChain-selectionFilter-patchesById-qOp '' \
  --senseImageTemplate-selectionChain-selectionFilter-patchesById-qPath '' \
  --senseImageTemplate-selectionChain-selectionFilter-selectionsByState-defaultIsNumeric  \
  --senseImageTemplate-selectionChain-selectionFilter-selectionsByState-fieldName '' \
  --senseImageTemplate-selectionChain-selectionFilter-selectionsByState-values-isNumeric  \
  --senseImageTemplate-selectionChain-selectionFilter-selectionsByState-values-number  \
  --senseImageTemplate-selectionChain-selectionFilter-selectionsByState-values-text '' \
  --senseImageTemplate-selectionChain-selectionType '' \
  --senseImageTemplate-selectionChain-temporaryBookmarkV2-id '' \
  --senseImageTemplate-selectionsByState-defaultIsNumeric  \
  --senseImageTemplate-selectionsByState-fieldName '' \
  --senseImageTemplate-selectionsByState-values-isNumeric  \
  --senseImageTemplate-selectionsByState-values-number  \
  --senseImageTemplate-selectionsByState-values-text '' \
  --senseImageTemplate-temporaryBookmarkV2-id '' \
  --senseImageTemplate-visualization-heightPx  \
  --senseImageTemplate-visualization-id '' \
  --senseImageTemplate-visualization-jsOpts  \
  --senseImageTemplate-visualization-patches-qOp '' \
  --senseImageTemplate-visualization-patches-qPath '' \
  --senseImageTemplate-visualization-patches-qValue '' \
  --senseImageTemplate-visualization-type '' \
  --senseImageTemplate-visualization-widthPx  \
  --sensePixelPerfectTemplate-selectionChain-persistentBookmark-id '' \
  --sensePixelPerfectTemplate-selectionChain-selectionFilter-patchesById-qOp '' \
  --sensePixelPerfectTemplate-selectionChain-selectionFilter-patchesById-qPath '' \
  --sensePixelPerfectTemplate-selectionChain-selectionFilter-selectionsByState-defaultIsNumeric  \
  --sensePixelPerfectTemplate-selectionChain-selectionFilter-selectionsByState-fieldName '' \
  --sensePixelPerfectTemplate-selectionChain-selectionFilter-selectionsByState-values-isNumeric  \
  --sensePixelPerfectTemplate-selectionChain-selectionFilter-selectionsByState-values-number  \
  --sensePixelPerfectTemplate-selectionChain-selectionFilter-selectionsByState-values-text '' \
  --sensePixelPerfectTemplate-selectionChain-selectionType '' \
  --sensePixelPerfectTemplate-selectionChain-temporaryBookmarkV2-id '' \
  --sensePixelPerfectTemplate-templateLocation-format '' \
  --sensePixelPerfectTemplate-templateLocation-path '' \
  --sensePowerPointTemplate-selectionChain-persistentBookmark-id '' \
  --sensePowerPointTemplate-selectionChain-selectionFilter-patchesById-qOp '' \
  --sensePowerPointTemplate-selectionChain-selectionFilter-patchesById-qPath '' \
  --sensePowerPointTemplate-selectionChain-selectionFilter-selectionsByState-defaultIsNumeric  \
  --sensePowerPointTemplate-selectionChain-selectionFilter-selectionsByState-fieldName '' \
  --sensePowerPointTemplate-selectionChain-selectionFilter-selectionsByState-values-isNumeric  \
  --sensePowerPointTemplate-selectionChain-selectionFilter-selectionsByState-values-number  \
  --sensePowerPointTemplate-selectionChain-selectionFilter-selectionsByState-values-text '' \
  --sensePowerPointTemplate-selectionChain-selectionType '' \
  --sensePowerPointTemplate-selectionChain-temporaryBookmarkV2-id '' \
  --sensePowerPointTemplate-templateLocation-format '' \
  --sensePowerPointTemplate-templateLocation-path '' \
  --senseSheetTemplate-appId '' \
  --senseSheetTemplate-persistentBookmark-id '' \
  --senseSheetTemplate-selectionsByState-defaultIsNumeric  \
  --senseSheetTemplate-selectionsByState-fieldName '' \
  --senseSheetTemplate-selectionsByState-values-isNumeric  \
  --senseSheetTemplate-selectionsByState-values-number  \
  --senseSheetTemplate-selectionsByState-values-text '' \
  --senseSheetTemplate-sheet-heightPx  \
  --senseSheetTemplate-sheet-id '' \
  --senseSheetTemplate-sheet-jsOpts  \
  --senseSheetTemplate-sheet-patchesById-qOp '' \
  --senseSheetTemplate-sheet-patchesById-qPath '' \
  --senseSheetTemplate-sheet-patchesById-qValue '' \
  --senseSheetTemplate-sheet-widthPx  \
  --senseSheetTemplate-temporaryBookmarkV2-id '' \
  --senseWordTemplate-selectionChain-persistentBookmark-id '' \
  --senseWordTemplate-selectionChain-selectionFilter-patchesById-qOp '' \
  --senseWordTemplate-selectionChain-selectionFilter-patchesById-qPath '' \
  --senseWordTemplate-selectionChain-selectionFilter-selectionsByState-defaultIsNumeric  \
  --senseWordTemplate-selectionChain-selectionFilter-selectionsByState-fieldName '' \
  --senseWordTemplate-selectionChain-selectionFilter-selectionsByState-values-isNumeric  \
  --senseWordTemplate-selectionChain-selectionFilter-selectionsByState-values-number  \
  --senseWordTemplate-selectionChain-selectionFilter-selectionsByState-values-text '' \
  --senseWordTemplate-selectionChain-selectionType '' \
  --senseWordTemplate-selectionChain-temporaryBookmarkV2-id '' \
  --senseWordTemplate-templateLocation-format '' \
  --senseWordTemplate-templateLocation-path '' \
  --type 'composition-1.0'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/reports" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"type":"composition-1.0","output":{"type":"pdfcomposition","outputId":"composition1","pdfCompositionOutput":{"pdfOutputs":[{"size":"A4","align":{"vertical":"middle","horizontal":"center"},"resizeType":"autofit","orientation":"A"},{"size":"A4","align":{"vertical":"middle","horizontal":"center"},"resizeType":"autofit","orientation":"A"}]}},"definitions":{"selectionsByState":{"sel1":{"$":[{"values":[{"text":"Arizona","isNumeric":false}],"fieldName":"Region","defaultIsNumeric":false}]}}},"compositionTemplates":[{"type":"sense-sheet-1.0","senseSheetTemplate":{"appId":"2451e58e-a1b9-4047-abf6-315e91d8a610","sheet":{"id":"5ffe3801-1b6d-439d-a849-84d0748358f1"},"selectionsByStateDef":"sel1"}},{"type":"sense-sheet-1.0","senseSheetTemplate":{"appId":"2451e58e-a1b9-4047-abf6-315e91d8a610","sheet":{"id":"ffrxJyA"},"selectionsByStateDef":"sel1"}}]}'

Example Response

{
  "message": "Report request has been accepted and is being processed.",
  "requestId": "c61841ac-7b35-4434-aa74-4421f10fc68e",
  "outputsUrl": "https://t.eu.qlikcloud.com:443/api/v1/reports/c61841ac-7b35-4434-aa74-4421f10fc68e/outputs"
}

Get report request outputs.

Get the list of the outputs produced so far for the given report request. The outputs are generated asynchronously and are complete only when the status of the report request is 'done' or 'failed' or 'aborted'.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • filter string

    The advanced filtering to use for the query. Refer to RFC 7644 for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive. The following fields support the eq (equals) operator: outputId Example: outputId eq "123" or outputId eq "321"

  • limit integer

    Limit the returned result set

    minimum = 1, maximum = 100, default = 20, default = 20

  • page string

    If present, the cursor that starts the page of data that is returned.

  • sort array of strings

    Sorting parameters

    Values may be any of: "+outputId""-outputId""+sizeBytes""-sizeBytes"

Path Parameters

  • id string
    Required

    Identifier of the request.

Responses

200

The outputs have been successfully returned.

  • application/json object
    Show application/json properties
    • data array of objects
      Required

      a list of outputs containing all the report outputs

      Show data properties
      • status string

        Status of the requested report.

        Can be one of: "queued""processing""done""failed""aborted""aborting"

      • traceId string
      • location string

        Location to download the generated report file.

        format = "uri"

      • outputId string

        The output ID

      • sizeBytes integer

        output size in bytes

      • exportErrors array of objects

        Errors occured during report generation.

        Show exportErrors properties
        • code string
          Required

          The unique code for the error

          • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
          • "REP-400008" Selections error.
          • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
          • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
          • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
          • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
          • "REP-400017" Static App size exceeded.
          • "REP-400018" Excel string length exceeded.
          • "REP-400020" Invalid Issuer.
          • "REP-400024" Cannot extract claims from JWT.
          • "REP-400028" Invalid Tags.
          • "REP-400029" Reload Entitlement Limit Reached.
          • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
          • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
          • "REP-400037" Max number of images exceeded in a report.
          • "REP-400038" Max number of nested levels exceeded in report.
          • "REP-400039" Max number of objects exceeded in a report.
          • "REP-400040" Max number of templates exceeded in a report.
          • "REP-400041" Unsupported dimension type for level tag.
          • "REP-400050" Error retrieving outputs.
          • "REP-400052" Report Request Aborted from internal error.
          • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
          • "REP-400055" Export options not allowed for this object.
          • "REP-400057" The sense object has an empty GenericType.
          • "REP-400102" Image rendering invalid strategy error on Sense client.
          • "REP-400240" Engine Client Global generic closure error
          • "REP-400260" Engine Client generic closure error.
          • "REP-400280" Engine Client proxy generic closure error.
          • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
          • "REP-401001" Unauthorized, bad JWT.
          • "REP-403000" Forbidden. The client does not have access rights to the content.
          • "REP-403001" App forbidden, the user does not have read permission on the app.
          • "REP-403002" Chart type not supported.
          • "REP-403019" Export is not available for app with enabled directQuery feature.
          • "REP-403025" No entitlement to perform the operation.
          • "REP-403026" No entitlement to perform the operation. Export capability is off.
          • "REP-403027" Object without Hypercube or unsupported object type.
          • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
          • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
          • "REP-404000" Not found. The server can not find the requested resource.
          • "REP-404001" App not found, the app does not exist or it has been deleted.
          • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
          • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
          • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
          • "REP-409001" App conflict.
          • "REP-409021" Reload timestamp constraint not met.
          • "REP-409046" Report aborted due to app reload.
          • "REP-422030" Apply variables error.
          • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
          • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
          • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
          • "REP-429014" The export could not be completed within the requested deadline.
          • "REP-429016" Exceeded max session tenant quota per day.
          • "REP-429022" Enigma generic abort.
          • "REP-400064" Missing Bookmark
          • "REP-500000" Fail to resolve resource.
          • "REP-500006" Fail to get report session parameters.
          • "REP-500014" The app did not open within 10 minutes.
          • "REP-500023" Validate Report Request Tags failure.
          • "REP-500045" Failure setting Bookmark timestamp.
          • "REP-500047" Error setting GroupState.
          • "REP-500053" Unexpected number of generated cycle reports.
          • "REP-500059" The App is corrupt.
          • "REP-500061" Engine Memory limit reached.
          • "REP-500062" Too many resolution attempts for a task.
          • "REP-500063" Engine terminated
          • "REP-500100" Image rendering generic error on Sense client.
          • "REP-500101" Image rendering could not set cookies error on Sense client.
          • "REP-500103" Image rendering JS timeout error on Sense client.
          • "REP-500104" Image rendering load URL timeout error on Sense client.
          • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
          • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
          • "REP-500107" Image rendering render timeout error on Sense client.
          • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
          • "REP-500109" Image rendering generic JS failure error on Sense client.
          • "REP-500200" Report Generator error.
          • "REP-500240" Engine Global generic closure error.
          • "REP-500260" Engine Websocket generic closure error.
          • "REP-500280" Engine proxy generic closure error.
          • "REP-503001" Rest Engine Error.
          • "REP-503005" Engine unavailable, qix-sessions error no engines available.
          • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
          • "REP-503060" Engine Service unavailable.
        • meta object

          Define the export error metadata. Each property is filled if it is related to the export error type.

          Show meta properties
          • appErrors array of objects

            Errors occurring when dealing with the app.

            Show appErrors properties
            • appId string

              app id

            • method string

              The method that is failing.

            • parameters object

              Parameters of method that fails.

              Show additional optional properties
              • string string
          • selectionErrors array of objects

            Errors occurring in selections.

            Show selectionErrors properties
            • detail string

              Details about the field selection error.

            • errorType string

              Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

            • fieldName string

              The field name that is missing.

            • stateName string

              The state name that is missing.

            • missingValues array of objects

              In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

              Show missingValues properties
              • text string

                String value of the field value.

              • number number

                format = float64

              • isNumeric boolean

                IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
            • isFieldNameMissing boolean Deprecated

              Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
        • title string
          Required

          A summary in english explaining what went wrong.

        • detail string

          Optional. MAY be used to provide more concrete details.
      • cycleSelections array of objects
        Show cycleSelections properties
        • values array of objects
          Required

          The values of the field to be selected.

          maxItems = 150000

          Show values properties
          • text string

            String value of the field value.

          • number number

            format = float64

          • isNumeric boolean

            IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
        • fieldName string
          Required

          The name of the field to be selected.

        • defaultIsNumeric boolean
          Required

          Default value that QFieldValue isNumeric property takes if missing.
    • links object
      Required
      Show links properties
      • next object
        Required
        Show next properties
        • href string

          format = "uri"

      • prev object
        Required
        Show prev properties
        • href string

          format = "uri"

      • self object
        Required
        Show self properties
        • href string

          format = "uri"

400

Bad request. Malformed syntax, errors in params.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

401

Unauthorized, JWT invalid or not provided.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

403

Forbidden, user did not authenticate.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

404

Not found.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

409

Conflicted request. Report aborted.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

429

Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.
GET /api/v1/reports/{id}/outputs 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.reports.getReportOutputs(
  '01562a37-23e3-4b43-865d-84c26122276c',
  {},
)
qlik report output ls '01562a37-23e3-4b43-865d-84c26122276c'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/reports/{id}/outputs" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "status": "processing",
      "traceId": "1234",
      "location": "https://t.eu.qlikcloud.com:443/api/v1/temp-contents/619b77be498fea00018de0e1?inline=1",
      "outputId": "c61841ac-7b35-4434-aa74-4421f10fc68e",
      "sizeBytes": 42,
      "exportErrors": [
        {
          "code": "string",
          "meta": {
            "appErrors": [
              {
                "appId": "11ecf638-0be4-4b94-a9e6-91218f34e175",
                "method": "GetObject",
                "parameters": {}
              }
            ],
            "selectionErrors": [
              {
                "detail": "string",
                "errorType": "fieldMissing",
                "fieldName": "Year",
                "stateName": "string",
                "missingValues": [
                  {
                    "text": "2021",
                    "number": 42,
                    "isNumeric": true
                  }
                ],
                "isFieldNameMissing": false
              }
            ]
          },
          "title": "string",
          "detail": "string"
        }
      ],
      "cycleSelections": [
        {
          "values": [
            {
              "text": "2021",
              "number": 42,
              "isNumeric": true
            }
          ],
          "fieldName": "Year",
          "defaultIsNumeric": true
        }
      ]
    }
  ],
  "links": {
    "next": {
      "href": "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
    },
    "prev": {
      "href": "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
    },
    "self": {
      "href": "https://tenant.qlik-cloud.com:443/api/v1/apps/816e23e1-03d2-446b-8721-cdee6b5e59cf/report-filters?filter=&filterTypes=REP&filterTypes=REP&limit=20&page=0&sort=%2Bname"
    }
  }
}

Get report request processing status.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • id string
    Required

    Identifier of the request.

Responses

200

Returns the request processing status.

  • application/json object
    Show application/json properties
    • status string
      Required

      Status of the requested report.

      Can be one of: "queued""processing""done""failed""aborted""visiting""aborting"

    • reasons array of objects Deprecated

      Present when status is failed. Deprecated. Use /reports/{id}/outputs instead.

      Show reasons properties
      • traceId string
      • outputId string

        The output identifier which uniquely identifies an output (PDF, image etc.) within the same request.

      • exportErrors array of objects

        Errors occured during report generation.

        Show exportErrors properties
        • code string
          Required

          The unique code for the error

          • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
          • "REP-400008" Selections error.
          • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
          • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
          • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
          • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
          • "REP-400017" Static App size exceeded.
          • "REP-400018" Excel string length exceeded.
          • "REP-400020" Invalid Issuer.
          • "REP-400024" Cannot extract claims from JWT.
          • "REP-400028" Invalid Tags.
          • "REP-400029" Reload Entitlement Limit Reached.
          • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
          • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
          • "REP-400037" Max number of images exceeded in a report.
          • "REP-400038" Max number of nested levels exceeded in report.
          • "REP-400039" Max number of objects exceeded in a report.
          • "REP-400040" Max number of templates exceeded in a report.
          • "REP-400041" Unsupported dimension type for level tag.
          • "REP-400050" Error retrieving outputs.
          • "REP-400052" Report Request Aborted from internal error.
          • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
          • "REP-400055" Export options not allowed for this object.
          • "REP-400057" The sense object has an empty GenericType.
          • "REP-400102" Image rendering invalid strategy error on Sense client.
          • "REP-400240" Engine Client Global generic closure error
          • "REP-400260" Engine Client generic closure error.
          • "REP-400280" Engine Client proxy generic closure error.
          • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
          • "REP-401001" Unauthorized, bad JWT.
          • "REP-403000" Forbidden. The client does not have access rights to the content.
          • "REP-403001" App forbidden, the user does not have read permission on the app.
          • "REP-403002" Chart type not supported.
          • "REP-403019" Export is not available for app with enabled directQuery feature.
          • "REP-403025" No entitlement to perform the operation.
          • "REP-403026" No entitlement to perform the operation. Export capability is off.
          • "REP-403027" Object without Hypercube or unsupported object type.
          • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
          • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
          • "REP-404000" Not found. The server can not find the requested resource.
          • "REP-404001" App not found, the app does not exist or it has been deleted.
          • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
          • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
          • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
          • "REP-409001" App conflict.
          • "REP-409021" Reload timestamp constraint not met.
          • "REP-409046" Report aborted due to app reload.
          • "REP-422030" Apply variables error.
          • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
          • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
          • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
          • "REP-429014" The export could not be completed within the requested deadline.
          • "REP-429016" Exceeded max session tenant quota per day.
          • "REP-429022" Enigma generic abort.
          • "REP-400064" Missing Bookmark
          • "REP-500000" Fail to resolve resource.
          • "REP-500006" Fail to get report session parameters.
          • "REP-500014" The app did not open within 10 minutes.
          • "REP-500023" Validate Report Request Tags failure.
          • "REP-500045" Failure setting Bookmark timestamp.
          • "REP-500047" Error setting GroupState.
          • "REP-500053" Unexpected number of generated cycle reports.
          • "REP-500059" The App is corrupt.
          • "REP-500061" Engine Memory limit reached.
          • "REP-500062" Too many resolution attempts for a task.
          • "REP-500063" Engine terminated
          • "REP-500100" Image rendering generic error on Sense client.
          • "REP-500101" Image rendering could not set cookies error on Sense client.
          • "REP-500103" Image rendering JS timeout error on Sense client.
          • "REP-500104" Image rendering load URL timeout error on Sense client.
          • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
          • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
          • "REP-500107" Image rendering render timeout error on Sense client.
          • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
          • "REP-500109" Image rendering generic JS failure error on Sense client.
          • "REP-500200" Report Generator error.
          • "REP-500240" Engine Global generic closure error.
          • "REP-500260" Engine Websocket generic closure error.
          • "REP-500280" Engine proxy generic closure error.
          • "REP-503001" Rest Engine Error.
          • "REP-503005" Engine unavailable, qix-sessions error no engines available.
          • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
          • "REP-503060" Engine Service unavailable.
        • meta object

          Define the export error metadata. Each property is filled if it is related to the export error type.

          Show meta properties
          • appErrors array of objects

            Errors occurring when dealing with the app.

            Show appErrors properties
            • appId string

              app id

            • method string

              The method that is failing.

            • parameters object

              Parameters of method that fails.

              Show additional optional properties
              • string string
          • selectionErrors array of objects

            Errors occurring in selections.

            Show selectionErrors properties
            • detail string

              Details about the field selection error.

            • errorType string

              Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

            • fieldName string

              The field name that is missing.

            • stateName string

              The state name that is missing.

            • missingValues array of objects

              In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

              Show missingValues properties
              • text string

                String value of the field value.

              • number number

                format = float64

              • isNumeric boolean

                IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
            • isFieldNameMissing boolean Deprecated

              Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
        • title string
          Required

          A summary in english explaining what went wrong.

        • detail string

          Optional. MAY be used to provide more concrete details.
    • results array of objects Deprecated

      Present when the status is "done". Deprecated. Use /reports/{id}/outputs instead.

      Show results properties
      • location string
        Required

        Location to download the generated report.

        format = "uri"

      • outputId string
        Required

        The output identifier which uniquely identifies an output (PDF, image etc.) within the same request.

      • exportErrors array of objects

        Errors occured during report generation.

        Show exportErrors properties
        • code string
          Required

          The unique code for the error

          • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
          • "REP-400008" Selections error.
          • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
          • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
          • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
          • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
          • "REP-400017" Static App size exceeded.
          • "REP-400018" Excel string length exceeded.
          • "REP-400020" Invalid Issuer.
          • "REP-400024" Cannot extract claims from JWT.
          • "REP-400028" Invalid Tags.
          • "REP-400029" Reload Entitlement Limit Reached.
          • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
          • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
          • "REP-400037" Max number of images exceeded in a report.
          • "REP-400038" Max number of nested levels exceeded in report.
          • "REP-400039" Max number of objects exceeded in a report.
          • "REP-400040" Max number of templates exceeded in a report.
          • "REP-400041" Unsupported dimension type for level tag.
          • "REP-400050" Error retrieving outputs.
          • "REP-400052" Report Request Aborted from internal error.
          • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
          • "REP-400055" Export options not allowed for this object.
          • "REP-400057" The sense object has an empty GenericType.
          • "REP-400102" Image rendering invalid strategy error on Sense client.
          • "REP-400240" Engine Client Global generic closure error
          • "REP-400260" Engine Client generic closure error.
          • "REP-400280" Engine Client proxy generic closure error.
          • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
          • "REP-401001" Unauthorized, bad JWT.
          • "REP-403000" Forbidden. The client does not have access rights to the content.
          • "REP-403001" App forbidden, the user does not have read permission on the app.
          • "REP-403002" Chart type not supported.
          • "REP-403019" Export is not available for app with enabled directQuery feature.
          • "REP-403025" No entitlement to perform the operation.
          • "REP-403026" No entitlement to perform the operation. Export capability is off.
          • "REP-403027" Object without Hypercube or unsupported object type.
          • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
          • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
          • "REP-404000" Not found. The server can not find the requested resource.
          • "REP-404001" App not found, the app does not exist or it has been deleted.
          • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
          • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
          • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
          • "REP-409001" App conflict.
          • "REP-409021" Reload timestamp constraint not met.
          • "REP-409046" Report aborted due to app reload.
          • "REP-422030" Apply variables error.
          • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
          • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
          • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
          • "REP-429014" The export could not be completed within the requested deadline.
          • "REP-429016" Exceeded max session tenant quota per day.
          • "REP-429022" Enigma generic abort.
          • "REP-400064" Missing Bookmark
          • "REP-500000" Fail to resolve resource.
          • "REP-500006" Fail to get report session parameters.
          • "REP-500014" The app did not open within 10 minutes.
          • "REP-500023" Validate Report Request Tags failure.
          • "REP-500045" Failure setting Bookmark timestamp.
          • "REP-500047" Error setting GroupState.
          • "REP-500053" Unexpected number of generated cycle reports.
          • "REP-500059" The App is corrupt.
          • "REP-500061" Engine Memory limit reached.
          • "REP-500062" Too many resolution attempts for a task.
          • "REP-500063" Engine terminated
          • "REP-500100" Image rendering generic error on Sense client.
          • "REP-500101" Image rendering could not set cookies error on Sense client.
          • "REP-500103" Image rendering JS timeout error on Sense client.
          • "REP-500104" Image rendering load URL timeout error on Sense client.
          • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
          • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
          • "REP-500107" Image rendering render timeout error on Sense client.
          • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
          • "REP-500109" Image rendering generic JS failure error on Sense client.
          • "REP-500200" Report Generator error.
          • "REP-500240" Engine Global generic closure error.
          • "REP-500260" Engine Websocket generic closure error.
          • "REP-500280" Engine proxy generic closure error.
          • "REP-503001" Rest Engine Error.
          • "REP-503005" Engine unavailable, qix-sessions error no engines available.
          • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
          • "REP-503060" Engine Service unavailable.
        • meta object

          Define the export error metadata. Each property is filled if it is related to the export error type.

          Show meta properties
          • appErrors array of objects

            Errors occurring when dealing with the app.

            Show appErrors properties
            • appId string

              app id

            • method string

              The method that is failing.

            • parameters object

              Parameters of method that fails.

              Show additional optional properties
              • string string
          • selectionErrors array of objects

            Errors occurring in selections.

            Show selectionErrors properties
            • detail string

              Details about the field selection error.

            • errorType string

              Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

            • fieldName string

              The field name that is missing.

            • stateName string

              The state name that is missing.

            • missingValues array of objects

              In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

              Show missingValues properties
              • text string

                String value of the field value.

              • number number

                format = float64

              • isNumeric boolean

                IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
            • isFieldNameMissing boolean Deprecated

              Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
        • title string
          Required

          A summary in english explaining what went wrong.

        • detail string

          Optional. MAY be used to provide more concrete details.
    • requestErrors array of objects

      Errors occured during report generation.

      Show requestErrors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.
    • statusLocation string

      Relative path to status location.

      format = "uri"

    • resolutionAttempts integer

      Count how many times the resolution of this report was attempted.

      format = int32

400

Bad request. Malformed syntax, errors in params.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

401

Unauthorized, JWT invalid or not provided.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

403

Forbidden, user did not authenticate.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

404

Not found.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

409

Conflicted request. Report aborted.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

429

Too many request. Indicates the user has sent too many requests in a given amount of time, aka "rate limiting".

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects

      Errors occured during report generation.

      Show errors properties
      • code string
        Required

        The unique code for the error

        • "REP-400000" Bad request. The server could not understand the request due to invalid syntax.
        • "REP-400008" Selections error.
        • "REP-400009" Maximum 16384 columns limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of columns you can download.
        • "REP-400010" Maximum 1048566 rows limit exceeded. Download data in a visualization can't generate an .xlsx file due to limitations to the number of rows you can download.
        • "REP-400011" The size of the downloaded Excel file exceed 100 MB limit. Download data in a visualization can't generate an .xlsx file due to limitations to the amount of data you can download.
        • "REP-400015" Bad request in enigma request. The patch value has invalid JSON format.
        • "REP-400017" Static App size exceeded.
        • "REP-400018" Excel string length exceeded.
        • "REP-400020" Invalid Issuer.
        • "REP-400024" Cannot extract claims from JWT.
        • "REP-400028" Invalid Tags.
        • "REP-400029" Reload Entitlement Limit Reached.
        • "REP-400035" Multiple selections detected in a field having OneAndOnlyone attribute.
        • "REP-400036" No selection detected in a field having OneAndOnlyone attribute.
        • "REP-400037" Max number of images exceeded in a report.
        • "REP-400038" Max number of nested levels exceeded in report.
        • "REP-400039" Max number of objects exceeded in a report.
        • "REP-400040" Max number of templates exceeded in a report.
        • "REP-400041" Unsupported dimension type for level tag.
        • "REP-400050" Error retrieving outputs.
        • "REP-400052" Report Request Aborted from internal error.
        • "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
        • "REP-400055" Export options not allowed for this object.
        • "REP-400057" The sense object has an empty GenericType.
        • "REP-400102" Image rendering invalid strategy error on Sense client.
        • "REP-400240" Engine Client Global generic closure error
        • "REP-400260" Engine Client generic closure error.
        • "REP-400280" Engine Client proxy generic closure error.
        • "REP-401000" Unauthorized. The client must authenticate itself to get the requested response.
        • "REP-401001" Unauthorized, bad JWT.
        • "REP-403000" Forbidden. The client does not have access rights to the content.
        • "REP-403001" App forbidden, the user does not have read permission on the app.
        • "REP-403002" Chart type not supported.
        • "REP-403019" Export is not available for app with enabled directQuery feature.
        • "REP-403025" No entitlement to perform the operation.
        • "REP-403026" No entitlement to perform the operation. Export capability is off.
        • "REP-403027" Object without Hypercube or unsupported object type.
        • "REP-403048" Forbidden. User does not have permission to export the report (access control usePermission)
        • "REP-403065" Forbidden. User does not have permission to read or update the report status or outputs (access control)
        • "REP-404000" Not found. The server can not find the requested resource.
        • "REP-404001" App not found, the app does not exist or it has been deleted.
        • "REP-404002" Chart not found, the chart does not exist or it has been deleted.
        • "REP-404003" Sheet not found, the sheet does not exist or it has been deleted or it is unavailable.
        • "REP-404004" Story not found, the story does not exist or it has been deleted or it is unavailable.
        • "REP-409001" App conflict.
        • "REP-409021" Reload timestamp constraint not met.
        • "REP-409046" Report aborted due to app reload.
        • "REP-422030" Apply variables error.
        • "REP-422051" There is no report to produce due to empty dataset or missing fields (the measure/dimension was removed or omitted in Section Access)
        • "REP-429000" Too many request. The user has sent too many requests in a given amount of time ("rate limiting").
        • "REP-429012" Exceeded max session tenant quota. A tenant has opened too many different sessions at the same time.
        • "REP-429014" The export could not be completed within the requested deadline.
        • "REP-429016" Exceeded max session tenant quota per day.
        • "REP-429022" Enigma generic abort.
        • "REP-400064" Missing Bookmark
        • "REP-500000" Fail to resolve resource.
        • "REP-500006" Fail to get report session parameters.
        • "REP-500014" The app did not open within 10 minutes.
        • "REP-500023" Validate Report Request Tags failure.
        • "REP-500045" Failure setting Bookmark timestamp.
        • "REP-500047" Error setting GroupState.
        • "REP-500053" Unexpected number of generated cycle reports.
        • "REP-500059" The App is corrupt.
        • "REP-500061" Engine Memory limit reached.
        • "REP-500062" Too many resolution attempts for a task.
        • "REP-500063" Engine terminated
        • "REP-500100" Image rendering generic error on Sense client.
        • "REP-500101" Image rendering could not set cookies error on Sense client.
        • "REP-500103" Image rendering JS timeout error on Sense client.
        • "REP-500104" Image rendering load URL timeout error on Sense client.
        • "REP-500105" Image rendering max paint attempts exceeded error on Sense client.
        • "REP-500106" Image rendering max JS attempts exceeded error on Sense client.
        • "REP-500107" Image rendering render timeout error on Sense client.
        • "REP-500108" Image rendering JS failure due to timeout error on Sense client.
        • "REP-500109" Image rendering generic JS failure error on Sense client.
        • "REP-500200" Report Generator error.
        • "REP-500240" Engine Global generic closure error.
        • "REP-500260" Engine Websocket generic closure error.
        • "REP-500280" Engine proxy generic closure error.
        • "REP-503001" Rest Engine Error.
        • "REP-503005" Engine unavailable, qix-sessions error no engines available.
        • "REP-503013" Session unavailable. The engine session used to create the report is unavailable.
        • "REP-503060" Engine Service unavailable.
      • meta object

        Define the export error metadata. Each property is filled if it is related to the export error type.

        Show meta properties
        • appErrors array of objects

          Errors occurring when dealing with the app.

          Show appErrors properties
          • appId string

            app id

          • method string

            The method that is failing.

          • parameters object

            Parameters of method that fails.

            Show additional optional properties
            • string string
        • selectionErrors array of objects

          Errors occurring in selections.

          Show selectionErrors properties
          • detail string

            Details about the field selection error.

          • errorType string

            Can be one of: "fieldMissing""fieldValuesMissing""stateMissing""groupStateGroupMissing""groupStateGroupNotApplicable""groupStateFieldDefMissing"

          • fieldName string

            The field name that is missing.

          • stateName string

            The state name that is missing.

          • missingValues array of objects

            In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and number may be set.

            Show missingValues properties
            • text string

              String value of the field value.

            • number number

              format = float64

            • isNumeric boolean

              IsNumeric tells whether the field value is text or number. Default value is equal to defaultIsNumeric property in QSelection.
          • isFieldNameMissing boolean Deprecated

            Deprecated, use errorType instead. True if the fieldName is missing. The missingValues array is empty in this case
      • title string
        Required

        A summary in english explaining what went wrong.

      • detail string

        Optional. MAY be used to provide more concrete details.
GET /api/v1/reports/{id}/status 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.reports.getReportStatus(
  '01562a37-23e3-4b43-865d-84c26122276c',
)
qlik report status '01562a37-23e3-4b43-865d-84c26122276c'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/reports/{id}/status" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "status": "done",
  "results": [
    {
      "location": "https://qlikcloud.com:443/api/v1/temp-contents/619baab68023910001efcb86?inline=1",
      "outputId": "output1"
    }
  ],
  "statusLocation": "/reports/01562a37-23e3-4b43-865d-84c26122276c/status",
  "resolutionAttempts": 1
}