openapi: 3.0.3
info:
  version: "6"
  title: Visual Analytics
  description: The Visual Analytics API provides simplified ways to perform basic tasks with reports.  Tasks include exporting a report as a PDF file, or as a package file, or exporting an image of a part of the report.
  contact:
    name: SAS Developers
    url: https://developer.sas.com
    email: devex@sas.com
tags:
  - name: Root
    description: The operations for the root resource.
  - name: Export
    description: The operations for immediate export of content.
  - name: Jobs
    description: The operations used by clients for asynchronous execution.
  - name: Internal
    description: The operations used only internally for asynchronous execution.
  - name: Report
    description: The operations used by clients for manipulating a report.
paths:
  /:
    get:
      tags:
        - Root
      summary: Get a list of top-level links
      operationId: root
      description: Returns a list of link objects for some of the primary resources surfaced by this API. The list includes basic actions that are identified by their `relation` properties, such as printing a report, exporting a report package, exporting the data in a report, etc. See the example response for the list of expected links with their relation names, types and URIs.
      responses:
        "200":
          description: OK
          content:
            application/vnd.sas.api+json:
              schema:
                $ref: "#/components/schemas/apiList"
              examples:
                default:
                  $ref: "#/components/examples/root"
                example-1:
                  value:
                    version: 1
                    links:
                      - rel: self
                        method: GET
                        type: application/vnd.sas.api
                        uri: /visualAnalytics
                        href: /visualAnalytics
                      - rel: printReport
                        method: GET
                        type: application/zip
                        uri: /visualAnalytics/reports/{reportId}/pdf
                        href: /visualAnalytics/reports/{reportId}/pdf
                      - rel: reportPackage
                        method: GET
                        type: application/zip
                        uri: /visualAnalytics/reports/{reportId}/package
                        href: /visualAnalytics/reports/{reportId}/package
                      - rel: reportImageSvg
                        method: GET
                        type: image/svg+xml
                        uri: /visualAnalytics/reports/{reportId}/svg
                        href: /visualAnalytics/reports/{reportId}/svg
                      - rel: reportImagePng
                        method: GET
                        type: image/png
                        uri: /visualAnalytics/reports/{reportId}/png
                        href: /visualAnalytics/reports/{reportId}/png
                      - rel: reportDataCsv
                        method: GET
                        type: text/csv
                        uri: /visualAnalytics/reports/{reportId}/csv
                        href: /visualAnalytics/reports/{reportId}/csv
                      - rel: exportPdf
                        method: POST
                        type: application/vnd.sas.visual.analytics.report.export.pdf.request
                        responseType: application/vnd.sas.visual.analytics.report.export.pdf.job
                        uri: /visualAnalytics/reports/{reportId}/exportPdf
                        href: /visualAnalytics/reports/{reportId}/exportPdf
            application/json:
              schema:
                $ref: "#/components/schemas/apiList"
              examples:
                default:
                  $ref: "#/components/examples/root"
          headers:
            Content-Type:
              description: Always returns "application/vnd.sas.api+json".
              schema:
                type: string
  "/reports/{reportId}/pdf":
    get:
      tags:
        - Export
      summary: Export a PDF of a report
      operationId: getExportedReportPdf
      description: Export a report as PDF.  Maintain the client connection to download the report even if it takes some time to generate the PDF.  Apply the query parameter values to the creation of the PDF output, overriding (1) defaults of the underlying rendering services, and also overriding (2) any defaults that were saved with the report by the SAS Visual Analytics application.
      parameters:
        - $ref: "#/components/parameters/reportId"
        - $ref: "#/components/parameters/reportObjects"
        - $ref: "#/components/parameters/orientation"
        - $ref: "#/components/parameters/paperSize"
        - $ref: "#/components/parameters/margin"
        - $ref: "#/components/parameters/showPageNumbers"
        - $ref: "#/components/parameters/showEmptyRowsAndColumns"
        - $ref: "#/components/parameters/includeTableOfContents"
        - $ref: "#/components/parameters/includeAppendix"
        - $ref: "#/components/parameters/includeComments"
        - $ref: "#/components/parameters/includeDetailsTables"
        - $ref: "#/components/parameters/expandClippedContent"
        - $ref: "#/components/parameters/includeCoverPage"
        - $ref: "#/components/parameters/coverPageText"
        - $ref: "#/components/parameters/Accept-Language"
        - $ref: "#/components/parameters/Accept-Locale"
      responses:
        "200":
          description: Successful execution. Response is the report in the requested PDF format.
          content:
            application/pdf: {}
          headers:
            Last-Modified:
              description: Timestamp response was created.
              schema:
                type: string
            Content-Type:
              schema:
                type: string
            Location:
              description: On success this header containers the URI of the generated PDF file
              schema:
                type: string
        "303":
          $ref: "#/components/responses/jobContinuation"
        "400":
          $ref: "#/components/responses/errorInRequest"
        "404":
          description: Not found Error
          content:
            aplication/json:
              schema:
                type: object
              examples:
                default:
                  $ref: "#/components/examples/export_error404"
  "/reports/{reportId}/svg":
    get:
      tags:
        - Export
      summary: Export SVG image of report or report object
      operationId: getExportedReportImageSVG
      description: Export image for the report or part of a report in Scalable Vector Graphics format. The returned content is as specified by the Accept header of the request as "image/svg+xml".
      parameters:
        - $ref: "#/components/parameters/reportId"
        - $ref: "#/components/parameters/reportObjectForImage"
        - $ref: "#/components/parameters/imageSize"
        - $ref: "#/components/parameters/Accept-Language"
        - $ref: "#/components/parameters/Accept-Locale"
      responses:
        "200":
          description: The image been created and is returned as the response body.
          content:
            image/svg+xml:
              schema:
                type: string
              example: <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="268" height="151" viewBox="0 0 268 151"> </svg>
          headers:
            Location:
              description: Not normally provided.
              schema:
                type: string
            Last-Modified:
              description: Timestamp response was created.
              schema:
                type: string
                format: date-time
        "303":
          $ref: "#/components/responses/jobContinuation"
        "400":
          $ref: "#/components/responses/errorInRequest"
        "403":
          description: Forbidden error.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
        "404":
          description: Not found Error
          content:
            aplication/json:
              schema:
                type: object
              examples:
                default:
                  $ref: "#/components/examples/export_error404"
  "/reports/{reportId}/png":
    get:
      tags:
        - Export
      summary: Export PNG image of report or report object
      operationId: getExportedReportImagePNG
      description: Export image for the report or part of a report in Portable Network Graphics format. The returned content is as specified by the Accept header of the request as "image/png+xml".
      parameters:
        - $ref: "#/components/parameters/reportId"
        - $ref: "#/components/parameters/reportObjectForImage"
        - $ref: "#/components/parameters/imageSize"
        - $ref: "#/components/parameters/Accept-Language"
        - $ref: "#/components/parameters/Accept-Locale"
      responses:
        "200":
          description: The image been created and is returned as the response body.
          content:
            image/png: {}
          headers:
            Location:
              description: Not normally provided.
              schema:
                type: string
            Last-Modified:
              description: Timestamp response was created.
              schema:
                type: string
                format: date-time
        "303":
          $ref: "#/components/responses/jobContinuation"
        "400":
          $ref: "#/components/responses/errorInRequest"
        "403":
          description: Forbidden error.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
        "404":
          description: Not found Error
          content:
            aplication/json:
              schema:
                type: object
              examples:
                default:
                  $ref: "#/components/examples/export_error404"
  "/reports/{reportId}/package":
    get:
      tags:
        - Export
      summary: Export a report package
      operationId: getExportedReportPackage
      description: Export a package for the report or report objects in compressed (zip) format. The returned content contains the report source files, plus the results of data queries and image rendering, constituting all that is needed for remote viewing of the report.
      parameters:
        - $ref: "#/components/parameters/reportId"
        - $ref: "#/components/parameters/reportObjects"
        - $ref: "#/components/parameters/Accept-Language"
        - $ref: "#/components/parameters/Accept-Locale"
      responses:
        "200":
          description: Successful execution. Response is the package in a compressed format.
          content:
            application/zip: {}
          headers:
            Last-Modified:
              description: Timestamp response was created.
              schema:
                type: string
                format: date-time
        "303":
          $ref: "#/components/responses/jobContinuation"
        "400":
          $ref: "#/components/responses/errorInRequest"
        "403":
          description: Forbidden error.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
        "404":
          description: Not found Error
          content:
            aplication/json:
              schema:
                type: object
              examples:
                default:
                  $ref: "#/components/examples/export_error404"
  "/reports/{reportId}/csv":
    get:
      tags:
        - Export
      summary: Export data for one object in a report as comma-separated values
      operationId: getExportedReportCSV
      description: Export the data for a report object in the requested exported format (comma-separated values). The report object can be any table, graph or crosstab in the report.
      parameters:
        - name: reportId
          in: path
          description: Identifier of report resource.
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/reportObject"
        - $ref: "#/components/parameters/Accept-Language"
        - $ref: "#/components/parameters/Accept-Locale"
      responses:
        "200":
          description: Successful execution. Response is the data in CSV format.
          content:
            text/csv:
              schema:
                type: string
              examples:
                default:
                  $ref: "#/components/examples/export_data_get_csv"
          headers:
            Last-Modified:
              description: Timestamp response was created.
              schema:
                type: string
        "400":
          description: Bad request error.
          content:
            application/json:
              schema:
                type: object
              examples:
                default:
                  $ref: "#/components/examples/get_export_data_400error"
        "403":
          description: Forbidden error.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
        "404":
          description: Not found Error
          content:
            aplication/json:
              schema:
                type: object
              examples:
                default:
                  $ref: "#/components/examples/export_error404"
  "/reports/{reportId}/tsv":
    get:
      tags:
        - Export
      summary: Export data for one object in a report as tab-separated values
      operationId: getExportedReportTSV
      description: Export the data for a report object in the requested exported format (tab-separated values). The report object can be any table, graph or crosstab in the report.
      parameters:
        - name: reportId
          in: path
          description: Identifier of report resource.
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/reportObject"
        - $ref: "#/components/parameters/Accept-Language"
        - $ref: "#/components/parameters/Accept-Locale"
      responses:
        "200":
          description: Successful execution. Response is the data in the requested format.
          content:
            text/tsv:
              schema:
                type: string
              examples:
                default:
                  $ref: "#/components/examples/export_data_get_tsv"
          headers:
            Last-Modified:
              description: Timestamp response was created..
              schema:
                type: string
        "400":
          description: Bad request error.
          content:
            application/json:
              schema:
                type: object
              examples:
                default:
                  $ref: "#/components/examples/get_export_data_400error"
        "403":
          description: Forbidden error.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
        "404":
          description: Not found Error
          content:
            aplication/json:
              schema:
                type: object
              examples:
                default:
                  $ref: "#/components/examples/export_error404"
  "/reports/{reportId}/xlsx":
    get:
      tags:
        - Export
      summary: Export data for one object in a report as an xlsx file
      operationId: getExportedReportWorksheet
      description: Export the data for a report object in the requested exported format. The report object can be any table, graph or crosstab in the report.
      parameters:
        - name: reportId
          in: path
          description: Identifier of report resource.
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/reportObject"
        - $ref: "#/components/parameters/Accept-Language"
        - $ref: "#/components/parameters/Accept-Locale"
      responses:
        "200":
          description: Successful execution. Response is the document in the requested format.
          content:
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                type: string
                format: binary
          headers:
            Last-Modified:
              description: Timestamp response was created.
              schema:
                type: string
        "400":
          description: Bad request error.
          content:
            application/json:
              schema:
                type: object
              examples:
                default:
                  $ref: "#/components/examples/get_export_data_400error"
        "403":
          description: Forbidden error.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
        "404":
          description: Not found Error
          content:
            aplication/json:
              schema:
                type: object
              examples:
                default:
                  $ref: "#/components/examples/export_error404"
  "/reports/{reportId}/exportPackage":
    post:
      tags:
        - Jobs
      summary: Create and run an action to export a report as a package file
      operationId: createExportPackageJob
      description: Start a job from the request information that creates and exports the report as a package file. This starts the process of creating a package, but returns quickly.  If the result is not ready by the time of the response, the client must poll until completion and then download the ZIP file. By default, only the user who created the package is authorized to retrieve it. For packages saved to a folder, the authorizations are controlled by the folder. Note that the /SASVisualAnalyticsCommon_capabilities/exportPackage capability is enforced on this operation. There is no support for creating a package with a back-level version; that is, the created package will have the service's current version of package file.
      parameters:
        - $ref: "#/components/parameters/reportId"
        - $ref: "#/components/parameters/Accept-Language"
        - $ref: "#/components/parameters/Accept-Locale"
      requestBody:
        content:
          application/vnd.sas.visual.analytics.report.export.package.request+json:
            schema:
              $ref: "#/components/schemas/exportPackageRequest"
            examples:
              default:
                $ref: "#/components/examples/export_package_request"
          application/json:
            schema:
              $ref: "#/components/schemas/exportPackageRequest"
            examples:
              default:
                $ref: "#/components/examples/export_package_request"
      responses:
        "201":
          description: The job ran and completed within the wait time allotted. The response body contains links to the job object, which contains information about result output.
          headers:
            Content-Type:
              schema:
                type: string
            Location:
              schema:
                type: string
          content:
            application/vnd.sas.visual.analytics.report.export.package.job+json:
              schema:
                $ref: "#/components/schemas/exportPackageJob"
              examples:
                default:
                  $ref: "#/components/examples/completed_export_package_job"
            application/json:
              schema:
                $ref: "#/components/schemas/exportPackageJob"
              examples:
                default:
                  $ref: "#/components/examples/completed_export_package_job"
        "202":
          description: The job has been created. The response body contains links to requery for results and status of the job. This is expected to be the most usual case.
          headers:
            Content-Type:
              schema:
                type: string
            Location:
              description: The same value as the self link URI.
              schema:
                type: string
          content:
            application/vnd.sas.visual.analytics.report.export.package.job+json:
              schema:
                $ref: "#/components/schemas/exportPackageJob"
              examples:
                default:
                  $ref: "#/components/examples/running_export_package_job"
        "400":
          $ref: "#/components/responses/errorInRequest"
        "403":
          description: Forbidden error.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
  "/reports/{reportId}/exportPdf":
    post:
      tags:
        - Jobs
      summary: Create and run an action to export a report as a PDF file
      operationId: createExportPdfJob
      description: Start a job from the request information that creates and exports the report as a PDF file. Apply the rendering option values in the request object to the creation of the PDF output.  The request's options override (1) any defaults of the underlying rendering services, and (2) any defaults that were saved with the report by the SAS Visual Analytics application.
      parameters:
        - $ref: "#/components/parameters/reportId"
        - $ref: "#/components/parameters/Accept-Language"
        - $ref: "#/components/parameters/Accept-Locale"
      requestBody:
        content:
          application/vnd.sas.visual.analytics.report.export.pdf.request+json:
            schema:
              $ref: "#/components/schemas/exportPdfRequest"
            examples:
              default:
                $ref: "#/components/examples/export_pdf_request"
          application/json:
            schema:
              $ref: "#/components/schemas/exportPdfRequest"
            examples:
              default:
                $ref: "#/components/examples/export_pdf_request"
      responses:
        "201":
          description: The job ran and completed within the wait time allotted. The response body contains links to the job object, which contains information about result output.
          headers:
            Content-Type:
              schema:
                type: string
            Location:
              description: If the job completed with the wait time, the Location header contains the actual result file's URI.
              schema:
                type: string
          content:
            application/vnd.sas.visual.analytics.report.export.pdf.job+json:
              schema:
                $ref: "#/components/schemas/exportPdfJob"
              examples:
                default:
                  $ref: "#/components/examples/completed_export_pdf_job"
            application/json:
              schema:
                $ref: "#/components/schemas/exportPdfJob"
              examples:
                default:
                  $ref: "#/components/examples/completed_export_pdf_job"
        "202":
          description: The job has been created.  The response body contains links to requery for results and status of the job.  This is expected to be the most usual case.
          headers:
            Content-Type:
              schema:
                type: string
            Location:
              description: The same as the self link URI.
              schema:
                type: string
          content:
            application/vnd.sas.visual.analytics.report.export.pdf.job+json:
              schema:
                $ref: "#/components/schemas/exportPdfJob"
              examples:
                default:
                  $ref: "#/components/examples/running_export_pdf_job"
            application/json:
              schema:
                $ref: "#/components/schemas/exportPdfJob"
              examples:
                default:
                  $ref: "#/components/examples/running_export_pdf_job"
        "400":
          $ref: "#/components/responses/errorInRequest"
  "/reports/{reportId}/exportImage":
    post:
      tags:
        - Jobs
      summary: Create and run an action to export an image file
      operationId: createExportImageJob
      description: Start a job from the request information that creates and exports the image as an SVG file or a PNG file.
      parameters:
        - $ref: "#/components/parameters/reportId"
        - $ref: "#/components/parameters/Accept-Language"
        - $ref: "#/components/parameters/Accept-Locale"
      requestBody:
        content:
          application/vnd.sas.visual.analytics.report.export.image.request+json:
            schema:
              $ref: "#/components/schemas/exportImageRequest"
            examples:
              default:
                $ref: "#/components/examples/export_image_default_request"
          application/json:
            schema:
              $ref: "#/components/schemas/exportImageRequest"
            examples:
              default:
                $ref: "#/components/examples/export_image_default_request"
      responses:
        "201":
          description: The job ran and completed within the wait time allotted. The response body contains links to the job object, which contains information about result output.
          headers:
            Content-Type:
              schema:
                type: string
            Location:
              description: If the job completed with the wait time, the Location header contains the actual result file's URI.
              schema:
                type: string
          content:
            application/vnd.sas.visual.analytics.report.export.image.job+json:
              schema:
                $ref: "#/components/schemas/exportImageJob"
              examples:
                default:
                  $ref: "#/components/examples/completed_export_image_job"
            application/json:
              schema:
                $ref: "#/components/schemas/exportImageJob"
              examples:
                default:
                  $ref: "#/components/examples/completed_export_image_job"
        "202":
          description: The job has been created.  The response body contains links to requery for results and status of the job.  This is expected to be the most usual case.
          headers:
            Content-Type:
              schema:
                type: string
            Location:
              description: The same as the self link URI.
              schema:
                type: string
          content:
            application/vnd.sas.visual.analytics.report.export.image.job+json:
              schema:
                $ref: "#/components/schemas/exportImageJob"
              examples:
                default:
                  $ref: "#/components/examples/running_export_image_job"
            application/json:
              schema:
                $ref: "#/components/schemas/exportImageJob"
              examples:
                default:
                  $ref: "#/components/examples/running_export_image_job"
        "400":
          $ref: "#/components/responses/errorInRequest"
        "403":
          description: Forbidden error.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
  /reports:
    post:
      tags:
        - Report
      summary: Create a report while applying the specified operation(s)
      operationId: createReport
      description: Create a report while applying the specified operation(s). The new report may be generated with a specific name and location by denoting the resultFolder and resultReportName in the body of the request. If neither of these are specified in the body, the a report named "Report" is generated in the location /folders/folders/@myFolder.
      requestBody:
        description: The request details identifying the operations to be performed on the new report.
        content:
          application/vnd.sas.report.operations.request+json:
            schema:
              $ref: "#/components/schemas/request"
            examples:
              addPage:
                $ref: "#/components/examples/requestAddPageOperation"
              addData:
                $ref: "#/components/examples/requestAddDataOperation"
              changeData:
                $ref: "#/components/examples/requestChangeDataOperationPost"
              applyDataView:
                $ref: "#/components/examples/requestApplyDataViewOperationPost"
              addObject:
                $ref: "#/components/examples/requestAddObjectOperationPost"
              setParameterValue:
                $ref: "#/components/examples/requestSetParameterValueOperation"
          application/json:
            schema:
              $ref: "#/components/schemas/request"
            examples:
              addPage:
                $ref: "#/components/examples/requestAddPageOperation"
              addData:
                $ref: "#/components/examples/requestAddDataOperation"
              changeData:
                $ref: "#/components/examples/requestChangeDataOperationPost"
              applyDataView:
                $ref: "#/components/examples/requestApplyDataViewOperationPost"
              addObject:
                $ref: "#/components/examples/requestAddObjectOperationPost"
              setParameterValue:
                $ref: "#/components/examples/requestSetParameterValueOperation"
        required: true
      responses:
        "201":
          description: The new report was successfully created.
          headers:
            Content-Type:
              description: Type of the response body.
              schema:
                type: string
            Location:
              description: The location of the new report.
              schema:
                type: string
            Etag:
              description: A tag that identifies this revision of the new report.
              schema:
                type: string
            Last-Modified:
              description: The last modified timestamp for the report.
              schema:
                type: string
          content:
            application/vnd.sas.report.operations.results+json:
              schema:
                $ref: "#/components/schemas/response"
              examples:
                addPage:
                  $ref: "#/components/examples/responseAddPageOperation"
                addData:
                  $ref: "#/components/examples/responseAddDataOperation"
                changeData:
                  $ref: "#/components/examples/responseChangeDataOperationPost"
                applyDataView:
                  $ref: "#/components/examples/responseApplyDataViewOperationPost"
                addObject:
                  $ref: "#/components/examples/responseAddObjectOperationPost"
                setParameterValue:
                  $ref: "#/components/examples/responseSetParameterValueOperation"
            application/json:
              schema:
                $ref: "#/components/schemas/response"
              examples:
                addPage:
                  $ref: "#/components/examples/responseAddPageOperation"
                addData:
                  $ref: "#/components/examples/responseAddDataOperation"
                changeData:
                  $ref: "#/components/examples/responseChangeDataOperationPost"
                applyDataView:
                  $ref: "#/components/examples/responseApplyDataViewOperationPost"
                addObject:
                  $ref: "#/components/examples/responseAddObjectOperationPost"
                setParameterValue:
                  $ref: "#/components/examples/responseSetParameterValueOperation"
        "400":
          description: This is a bad request. The request is not properly formed or the body is missing required fields.
          headers:
            Content-Type:
              description: Type of the error in the body.
              schema:
                type: string
          content:
            application/vnd.sas.report.operations.error+json:
              schema:
                $ref: "#/components/schemas/response"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseAddDataOperationFailure"
            application/json:
              schema:
                $ref: "#/components/schemas/response"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseAddDataOperationFailure"
        "404":
          description: The result report folder does not exist.
          headers:
            Content-Type:
              description: Type of the error body.
              schema:
                type: string
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseErrorReportNotFound"
                addObjectOperation:
                  $ref: "#/components/examples/responseErrorReportNotFound"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseErrorReportNotFound"
                addObjectOperation:
                  $ref: "#/components/examples/responseErrorReportNotFound"
        "409":
          description: A report with the same name already exists in the destination folder.
          headers:
            Content-Type:
              description: Type of the error body.
              schema:
                type: string
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseErrorFileAlreadyExists"
                addObjectOperation:
                  $ref: "#/components/examples/responseErrorFileAlreadyExists"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseErrorFileAlreadyExists"
                addObjectOperation:
                  $ref: "#/components/examples/responseErrorFileAlreadyExists"
  "/reports/{reportId}":
    put:
      tags:
        - Report
      summary: Update a report while applying the specified operation(s)
      operationId: updateReport
      description: Create or update a report while applying the specified operation(s). The source report for the updates is denoted in the uri of the request. A new report may be generated by denoting a resultFolder or resultReportName in the body of the request. If neither of these are specified in the body, the source report is directly updated.
      parameters:
        - name: reportId
          in: path
          description: The id of an existing report.
          required: true
          schema:
            type: string
        - name: If-Match
          in: header
          description: The value of the etag that was returned from a GET or previous PUT of this type. This header is optional, but if provided, this MUST match exactly the current value of the etag of the object.
          schema:
            type: string
        - name: If-Unmodified-Since
          in: header
          schema:
            type: string
          description: A date to compare against the saved report, to assert the precondition for this request, that the request will only execute if the report has been unmodified since this specified date.
      requestBody:
        description: The request details identifying the operations to be performed on the report.
        content:
          application/vnd.sas.report.operations.request+json:
            schema:
              $ref: "#/components/schemas/request"
            examples:
              addPage:
                $ref: "#/components/examples/requestAddPageOperation"
              addData:
                $ref: "#/components/examples/requestAddDataOperation"
              changeData:
                $ref: "#/components/examples/requestChangeDataOperationPut"
              applyDataView:
                $ref: "#/components/examples/requestApplyDataViewOperationPut"
              addObject:
                $ref: "#/components/examples/requestAddObjectOperationPut"
              setParameterValue:
                $ref: "#/components/examples/requestSetParameterValueOperation"
          application/json:
            schema:
              $ref: "#/components/schemas/request"
            examples:
              addPage:
                $ref: "#/components/examples/requestAddPageOperation"
              addData:
                $ref: "#/components/examples/requestAddDataOperation"
              changeData:
                $ref: "#/components/examples/requestChangeDataOperationPut"
              applyDataView:
                $ref: "#/components/examples/requestApplyDataViewOperationPut"
              addObject:
                $ref: "#/components/examples/requestAddObjectOperationPut"
              setParameterValue:
                $ref: "#/components/examples/requestSetParameterValueOperation"
        required: true
      responses:
        "200":
          description: The report was successfully updated.
          headers:
            Content-Type:
              description: Type of the response body.
              schema:
                type: string
            Location:
              description: The location of the updated report.
              schema:
                type: string
            Etag:
              description: A tag that identifies this revision of the new report.
              schema:
                type: string
            Last-Modified:
              description: The last modified timestamp for the report.
              schema:
                type: string
          content:
            application/vnd.sas.report.operations.results+json:
              schema:
                $ref: "#/components/schemas/response"
              examples:
                addPage:
                  $ref: "#/components/examples/responseAddPageOperation"
                addData:
                  $ref: "#/components/examples/responseAddDataOperation"
                changeData:
                  $ref: "#/components/examples/responseChangeDataOperationPut"
                applyDataView:
                  $ref: "#/components/examples/responseApplyDataViewOperationPut"
                addObject:
                  $ref: "#/components/examples/responseAddObjectOperationPut"
                setParameterValue:
                  $ref: "#/components/examples/responseSetParameterValueOperation"
            application/json:
              schema:
                $ref: "#/components/schemas/response"
              examples:
                addPage:
                  $ref: "#/components/examples/responseAddPageOperation"
                addData:
                  $ref: "#/components/examples/responseAddDataOperation"
                changeData:
                  $ref: "#/components/examples/responseChangeDataOperationPut"
                applyDataView:
                  $ref: "#/components/examples/responseApplyDataViewOperationPut"
                addObject:
                  $ref: "#/components/examples/responseAddObjectOperationPut"
                setParameterValue:
                  $ref: "#/components/examples/responseSetParameterValueOperation"
        "201":
          description: The new report was successfully created.
          headers:
            Content-Type:
              description: Type of the response body.
              schema:
                type: string
            Location:
              description: The location of the new report.
              schema:
                type: string
            Etag:
              description: A tag that identifies this revision of the new report.
              schema:
                type: string
            Last-Modified:
              description: The last modified timestamp for the report.
              schema:
                type: string
          content:
            application/vnd.sas.report.operations.results+json:
              schema:
                $ref: "#/components/schemas/response"
              examples:
                addPage:
                  $ref: "#/components/examples/responseAddPageOperation"
                addData:
                  $ref: "#/components/examples/responseAddDataOperation"
                changeData:
                  $ref: "#/components/examples/responseChangeDataOperationPut"
                addObject:
                  $ref: "#/components/examples/responseAddObjectOperationPut"
                applyDataView:
                  $ref: "#/components/examples/responseApplyDataViewOperationPut"
                setParameterValue:
                  $ref: "#/components/examples/responseSetParameterValueOperation"
            application/json:
              schema:
                $ref: "#/components/schemas/response"
              examples:
                addPage:
                  $ref: "#/components/examples/responseAddPageOperation"
                addData:
                  $ref: "#/components/examples/responseAddDataOperation"
                changeData:
                  $ref: "#/components/examples/responseChangeDataOperationPut"
                applyDataView:
                  $ref: "#/components/examples/responseApplyDataViewOperationPut"
                addObject:
                  $ref: "#/components/examples/responseAddObjectOperationPut"
                setParameterValue:
                  $ref: "#/components/examples/responseSetParameterValueOperation"
        "400":
          description: This is a bad request. The request is not properly formed or the body is missing required fields or the update has failed.
          headers:
            Content-Type:
              description: Type of the response body.
              schema:
                type: string
            Etag:
              description: A tag that identifies this revision of the new report.
              schema:
                type: string
            Last-Modified:
              description: The last modified timestamp for the report.
              schema:
                type: string
          content:
            application/vnd.sas.report.operations.error+json:
              schema:
                $ref: "#/components/schemas/response"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseAddDataOperationFailure"
            application/json:
              schema:
                $ref: "#/components/schemas/response"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseAddDataOperationFailure"
        "404":
          description: The source report does not exist or the result report folder does not exist.
          headers:
            Content-Type:
              description: Type of the error body.
              schema:
                type: string
            Etag:
              description: A tag that identifies this revision of the new report.
              schema:
                type: string
            Last-Modified:
              description: The last modified timestamp for the report.
              schema:
                type: string
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseErrorReportNotFound"
                addObjectOperation:
                  $ref: "#/components/examples/responseErrorReportNotFound"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseErrorReportNotFound"
                addObjectOperation:
                  $ref: "#/components/examples/responseErrorReportNotFound"
        "409":
          description: A report with the same name already exists in the destination folder.
          headers:
            Content-Type:
              description: Type of the response body.
              schema:
                type: string
            Etag:
              description: A tag that identifies this revision of the report.
              schema:
                type: string
            Last-Modified:
              description: The last modified timestamp of the report.
              schema:
                type: string
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseErrorFileAlreadyExists"
                addObjectOperation:
                  $ref: "#/components/examples/responseErrorFileAlreadyExists"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseErrorFileAlreadyExists"
                addObjectOperation:
                  $ref: "#/components/examples/responseErrorFileAlreadyExists"
        "412":
          description: The if-match etag value provided does not match the current version of the report or the report has been modified since the if-unmodified-since value provided.
          headers:
            Content-Type:
              description: Type of the response body.
              schema:
                type: string
            Etag:
              description: A tag that identifies this revision of the report.
              schema:
                type: string
            Last-Modified:
              description: The last modified timestamp of the report.
              schema:
                type: string
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseErrorFailedPrecondition"
                addObjectOperation:
                  $ref: "#/components/examples/responseErrorFailedPrecondition"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseErrorFailedPrecondition"
                addObjectOperation:
                  $ref: "#/components/examples/responseErrorFailedPrecondition"
        "428":
          description: Either an if-match etag value or an if-unmodified-since value is required in request header.
          headers:
            Content-Type:
              description: Type of the error body.
              schema:
                type: string
            Etag:
              description: A tag that identifies this revision of the report.
              schema:
                type: string
            Last-Modified:
              description: The last modified timestamp of the report.
              schema:
                type: string
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseErrorNoPrecondition"
                addObjectOperation:
                  $ref: "#/components/examples/responseErrorNoPrecondition"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                addDataOperation:
                  $ref: "#/components/examples/responseErrorNoPrecondition"
                addObjectOperation:
                  $ref: "#/components/examples/responseErrorNoPrecondition"
  "/reports/{reportId}/exportData":
    post:
      tags:
        - Jobs
      summary: Create and run an action to export a data file
      operationId: createExportDataJob
      description: Start a job from the request information to export the data for a report object as a datafile. The format of the file is specified by an option as comma-separated values, tab-separated values, or a spreadsheet in Excel format.
      parameters:
        - $ref: "#/components/parameters/reportId"
        - $ref: "#/components/parameters/Accept-Language"
        - $ref: "#/components/parameters/Accept-Locale"
      requestBody:
        content:
          application/vnd.sas.visual.analytics.report.export.data.request+json:
            schema:
              $ref: "#/components/schemas/exportDataRequest"
            examples:
              default:
                $ref: "#/components/examples/export_data_default_request"
          application/json:
            schema:
              $ref: "#/components/schemas/exportDataRequest"
            examples:
              default:
                $ref: "#/components/examples/export_data_default_request"
      responses:
        "201":
          description: The job ran and completed within the wait time allotted. The response body contains links to the job object, which contains information about result output.
          headers:
            Content-Type:
              schema:
                type: string
            Location:
              description: If the job completed with the wait time, the Location header contains the actual result file's URI.
              schema:
                type: string
          content:
            application/vnd.sas.visual.analytics.report.export.data.job+json:
              schema:
                $ref: "#/components/schemas/exportDataJob"
              examples:
                completed:
                  $ref: "#/components/examples/completed_export_data_job"
                failed:
                  $ref: "#/components/examples/failed_export_data_job"
            application/json:
              schema:
                $ref: "#/components/schemas/exportDataJob"
              examples:
                default:
                  $ref: "#/components/examples/completed_export_data_job"
        "202":
          description: The job has been created.  The response body contains links to requery for results and status of the job.  This is expected to be the most usual case.
          headers:
            Content-Type:
              schema:
                type: string
            Location:
              description: The same as the self link URI.
              schema:
                type: string
          content:
            application/vnd.sas.visual.analytics.report.export.data.job+json:
              schema:
                $ref: "#/components/schemas/exportDataJob"
              examples:
                default:
                  $ref: "#/components/examples/running_export_data_job"
            application/json:
              schema:
                $ref: "#/components/schemas/exportDataJob"
              examples:
                default:
                  $ref: "#/components/examples/running_export_data_job"
        "400":
          description: The job failed with bad request error
          headers:
            Content-Type:
              schema:
                type: string
            Location:
              description: The same as the self link URI.
              schema:
                type: string
          content:
            application/vnd.sas.visual.analytics.report.export.data.job+json:
              schema:
                $ref: "#/components/schemas/exportDataJob"
              examples:
                default:
                  $ref: "#/components/examples/Notfound_failed_export_data_job"
        "403":
          description: Forbidden error.
          content:
            application/vnd.sas.error+json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
            application/json:
              schema:
                $ref: "#/components/schemas/error2"
              examples:
                authorizationDenied:
                  $ref: "#/components/examples/authorizationDenied"
  "/jobs/{jobId}":
    get:
      operationId: getJobStatus
      tags:
        - Jobs
      summary: Get the job with its status and links to results
      description: Get the job with its status and links to results. This operation is specific to the case of asynchronous execution of a report action job.  If the job has completed and is successful, the response object will have links to individual results.
      parameters:
        - name: jobId
          in: path
          description: The identifier of an existing job that might not be running.
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Success.
          headers:
            Content-Type:
              schema:
                type: string
            Location:
              description: Provided if meaningful, such as when the job is complete and results are available.
              schema:
                type: string
            Last-Modified:
              description: Timestamp response was created.
              schema:
                type: string
          content:
            application/vnd.sas.visual.analytics.report.export.pdf.job+json:
              schema:
                $ref: "#/components/schemas/exportPdfJob"
              examples:
                default:
                  $ref: "#/components/examples/completed_export_pdf_job"
            application/vnd.sas.visual.analytics.report.export.package.job+json:
              schema:
                $ref: "#/components/schemas/exportPackageJob"
              examples:
                default:
                  $ref: "#/components/examples/export_package_job200"
            application/vnd.sas.visual.analytics.report.export.image.job+json:
              schema:
                $ref: "#/components/schemas/exportImageJob"
              examples:
                default:
                  $ref: "#/components/examples/completed_export_image_job"
            application/vnd.sas.visual.analytics.report.export.data.job+json:
              schema:
                $ref: "#/components/schemas/exportDataJob"
              examples:
                default:
                  $ref: "#/components/examples/completed_export_data_job"
            application/json:
              schema:
                $ref: "#/components/schemas/exportPdfJob"
              examples:
                default:
                  $ref: "#/components/examples/completed_export_pdf_job"
        "400":
          $ref: "#/components/responses/errorInRequest"
        "404":
          description: Job not found Error
          content:
            aplication/json:
              schema:
                type: object
              examples:
                default:
                  $ref: "#/components/examples/export_error404"
    delete:
      operationId: deleteJobStatus
      tags:
        - Jobs
      summary: Delete the job with its status and links to results
      description: Delete the job information. This operation is specific to the case of asynchronous execution of a report action job.  If the job is still running, attempt to cancel it. This does not attempt to delete result files that reside under control of other services.
      parameters:
        - name: jobId
          in: path
          description: The identifier of an existing job.
          required: true
          schema:
            type: string
      responses:
        "204":
          description: Successfully deleted. Nothing to be returned.
          headers:
            Location:
              description: Provided if meaningful.
              schema:
                type: string
        "400":
          $ref: "#/components/responses/errorInRequest"
        "404":
          description: Job not found Error
          content:
            aplication/json:
              schema:
                type: object
              examples:
                default:
                  $ref: "#/components/examples/export_error404"
servers:
  - url: http://example.com/visualAnalytics
    description: The base URL for the service.
components:
  responses:
    errorInRequest:
      description: There was an error in the request.
      headers:
        Content-Type:
          description: Usually application/vnd.sas.error+json
          schema:
            type: string
        Location:
          description: Provided if a location would be meaningful in the error context.
          schema:
            type: string
        Last-Modified:
          description: Timestamp response was created.
          schema:
            type: string
      content:
        application/vnd.sas.error+json:
          schema:
            $ref: "#/components/schemas/error2"
          examples:
            default:
              $ref: "#/components/examples/error2"
        application/json:
          schema:
            $ref: "#/components/schemas/error2"
          examples:
            default:
              $ref: "#/components/examples/error2"
    jobContinuation:
      description: The operation could not be completed before the wait period expired. This redirect (See Other) continues the process of waiting for the result.  It is used to provide liveness to the browser transmit queue.  Note that although this practice of redirecting is common, clients that cannot follow a redirect must either not use this method or specify a longer `wait` period.
      content:
        application/json:
          schema:
            type: string
          example: The operation could not be completed before the wait period expired.
      headers:
        Location:
          description: A URI back to this service to wait for a pending result.
          schema:
            type: string
        Last-Modified:
          description: Timestamp response was created.
          schema:
            type: string
  parameters:
    reportId:
      name: reportId
      in: path
      description: Identifier of an existing report resource. Report identifiers are generated by the Reports API when reports are created.
      required: true
      schema:
        type: string
      example: 12345678-abcd-ef12-3456-123456789abc
    reportObjects:
      name: reportObjects
      in: query
      required: false
      description: This parameter lists the labels of the report objects to include in the request. Multiple object labels are separated by commas. The labels can be quoted to avoid problems with spaces and special characters. If this is left empty, the result varies depending on the type of output. Report objects include visual elements like graphs, tables, and visual containers that the author has created in the layout, as well as complete pages. Specifying the object by its label makes it more convenient for the report author or viewer and does not to expose the internal names of objects in the model. However, if the client knows the internal identifier of a report object, it can be used instead of the label.
      schema:
        type: string
      example: Bar+Chart+1,Cluster+Detail+Table
    reportObjectForImage:
      name: reportObject
      in: query
      required: false
      description: The name of the report object to render in the image. If this is left empty, the image is a representative output from the first page of the report. Report objects include visual elements like graphs, tables, and visual containers that the author has created in the layout, as well as complete pages. Specifying the object by its label makes it more convenient for the report author or viewer and does not to expose the internal names of objects in the model. However, if the client knows the internal identifier of a report object, it can be used instead of the label.
      schema:
        type: string
      example: Bar+Chart+1
    reportObject:
      name: reportObject
      in: query
      required: true
      description: The name of the report object as shown in the VA user interface. Report objects include visual elements like graphs, tables, and visual containers that the author has created in the layout, as well as complete pages. Specifying the object by its label makes it more convenient for the report author or viewer and does not to expose the internal names of objects in the model. However, if the client knows the internal identifier of a report object, it can be used instead of the label.
      schema:
        type: string
      example: Bar+Chart+1
    waitParameter:
      name: wait
      in: query
      required: false
      description: The number of seconds to wait for an update before returning from the "long poll". After this duration has passed, the API returns an HTTP status of 303 to the client with a redirect back to the service so that polling can continue. A system-imposed limit might reduce this requested value.
      schema:
        type: integer
        default: 5
    orientation:
      name: orientation
      in: query
      schema:
        type: string
        enum:
          - landscape
          - portrait
        default: landscape
      description: The page orientation. If this query parameter is set, it overrides any orientation that is saved in the report by the Visual Analytics UI and the default value defined by other supporting services.
    paperSize:
      name: paperSize
      in: query
      schema:
        type: string
        enum:
          - letter
          - legal
          - A3
          - A4
          - A5
          - B4
          - B5
          - ledger
        default: letter
      description: The paper size designation from the enumerated list. Custom sizes are not provided in version 1. If this query parameter is set, it overrides any paperSize that is saved in the report by the Visual Analytics UI and the default value defined by other supporting services.
    margin:
      name: margin
      in: query
      schema:
        $ref: "#/components/schemas/margin"
      description: "A margin value that is applied to all four margins of the page. It is nonnegative number, integer, or floating point, which is followed by the unit. The unit can be one of the following two-letter abbreviations: in, cm, mm, pt , px , em, or ex."
      examples:
        inches:
          value: 1.25in
        centimeters:
          value: 2.5cm
        integerAllowed:
          value: 25mm
    includeTableOfContents:
      name: includeTableOfContents
      in: query
      schema:
        type: boolean
        default: false
      description: Indicates whether to add a table of contents.
    showPageNumbers:
      name: showPageNumbers
      in: query
      schema:
        type: boolean
        default: true
      description: Indicates whether page numbers should be displayed.
    showEmptyRowsAndColumns:
      name: showEmptyRowsAndColumns
      in: query
      schema:
        type: boolean
        default: false
      description: Indicates whether empty rows and columns should be included to fill the allocated layout space for list tables and crosstabs.
    includeAppendix:
      name: includeAppendix
      in: query
      schema:
        type: boolean
        default: true
      description: Indicates whether the appendix should be included.  The appendix can contain comments, detail tables, and parts that were clipped in the main body of the report.
    includeComments:
      name: includeComments
      in: query
      schema:
        type: boolean
        default: false
      description: Indicates whether the comments should be included in the appendix.
    includeDetailsTables:
      name: includeDetailsTables
      in: query
      schema:
        type: boolean
        default: false
      description: Indicates whether the detail tables should be included in the appendix.
    expandClippedContent:
      name: expandClippedContent
      in: query
      schema:
        type: boolean
        default: false
      description: Enables you to see all of the content for tables, crosstabs, gauges, and containers. This includes content that is only partially available in the layout of the page. Each object is displayed on a separate page at the end of the report.
    includeCoverPage:
      name: includeCoverPage
      in: query
      schema:
        type: boolean
        default: true
      description: Indicates whether a cover page should be included. The cover page can include the name of the report, the date, the user name, and the number of pages.
    coverPageText:
      name: coverPageText
      in: query
      schema:
        type: string
        default: ""
      description: Optional text to be included on the cover page. This setting is ignored if includeCoverPage is false.
    imageSize:
      name: size
      in: query
      required: true
      description: Size of the resulting image in the form "9999px,9999px", where the horizontal dimension is before the comma and the vertical dimension is afterward. The two characters after the digits are reserved for unit specifiers; for example, "1024px,768px".  The only units currently supported are pixels ("px") but the unit must be specified. This parameter must be specified.
      schema:
        type: string
        pattern: /[0-9]{2,6}[\,][0-9]{2,6}/
    Accept-Language:
      name: Accept-Language
      in: header
      description: The user's language, which is used in both rendering and caching. For technical details, see "/tools.ietf.org/html/rfc7231#section-5.3.5"  It affects the language of reports if they have been translated. This setting overrides any other user preference that has been set, such as the "offline process locale" preference in Visual Analytics. If this header is not set and there is no user preference, the language is the default language of the service.
      required: false
      schema:
        type: string
    Accept-Locale:
      name: Accept-Locale
      in: header
      description: A "format locale" that is distinct from the user's language (Accept-Language). Its syntax is similar to Accept-Language. It is honored in running of queries and formatting of values. This setting overrides any other user preference that has been set, such as the "regional locale for formats" preference in Visual Analytics. If this header is not set and there is no user preference, the format locale is the default locale of the service.
      required: false
      allowEmptyValue: true
      schema:
        type: string
    Accept-Item:
      name: Accept-Item
      in: header
      description: The requested media type of the entries in a response collection
      required: false
      allowEmptyValue: false
      schema:
        type: string
  schemas:
    margin:
      type: string
      default: .25in
      description: A margin value that is applied to all four margins of the page. It is nonnegative number, integer, or floating point, which is followed by the unit. The unit can be one of several two-letter abbreviations, such as "in", "cm", "mm", "pt", "px", "em", and "ex".
      pattern: \d*.\d*(in|cm|mm|pt|px|em|ex)
    paperSize:
      type: string
      enum:
        - letter
        - legal
        - A3
        - A4
        - A5
        - B4
        - B5
        - ledger
      default: letter
      description: The paper size designation for print format rendering of reports.
    replacementStrategy:
      type: string
      description: The strategy for handling name collision when saving the result file.  The value `replace` means overwrite any pre-existing file. The value `rename` specifies that the service should modify the requested name to be unique, such as by appending a number to the name. The default value is `rename`.
      enum:
        - replace
        - rename
    reportObjectLabelForImage:
      description: The name of the report object to render in the exported file. If this is left empty, the image will be a rendering of the first page of the report. Report objects include visual elements like graphs, tables, visual containers that the author has created in the layout, and complete pages. Specifying the object by its label makes it more convenient for the report author or viewer and does not to expose the internal names of objects in the model. However, if the client knows the internal identifier of a report object, it can be used instead of the label.
      type: string
      example: Dual Axis Bar-Line - Merchandise Hierarchy 1
    reportObjectLabels:
      description: A list of report object names for the objects to include in the exported file. If left empty, the result is dependent on the type of the export.  For some types of export, omitting report objects means that the entire report will be processed. Report objects include visual elements like graphs and tables, visual containers that the author has created in the layout, and complete pages. Labels are not forced to be unique because they can be edited by the user. The design makes it more convenient for the report author or viewer and does not to expose the internal names of objects in the model. However, if the client knows the internal identifier of a report object, it can be used instead of the label.
      type: array
      items:
        type: string
    exportPdfRequest:
      type: object
      description: Information about the PDF that is requested.
      x-sas-media-type:
        name: application/vnd.sas.visual.analytics.report.export.pdf.request
        version: 1
      required:
        - version
        - options
      properties:
        resultFolder:
          $ref: "#/components/schemas/resultFolder"
        resultFilename:
          $ref: "#/components/schemas/resultFilename"
        nameConflict:
          $ref: "#/components/schemas/replacementStrategy"
        reportObjects:
          $ref: "#/components/schemas/reportObjectLabels"
        wait:
          $ref: "#/components/schemas/waitSeconds"
        timeout:
          $ref: "#/components/schemas/jobTimeout"
        options:
          $ref: "#/components/schemas/exportPdfOptions"
        version:
          type: integer
          description: Version of this request object, which is currently version 1.
    exportPackageRequest:
      type: object
      description: Information about package that is to be exported. The reportObjects property can be used to reduce the size of the resulting package. The default is to include all visual elements and pages in the report. <p> If the folder is not specified, the package is retained for a time, but will not be visible in file selection windows, such as in SAS Drive. It is cached temporarily by the Report Packages service for a period of time sufficient for clients to check the status of the package job and download it.
      x-sas-media-type:
        name: application/vnd.sas.visual.analytics.report.export.package.request
        version: 1
      required:
        - version
      properties:
        resultFolder:
          $ref: "#/components/schemas/resultFolder"
        resultFilename:
          $ref: "#/components/schemas/resultFilename"
        nameConflict:
          $ref: "#/components/schemas/replacementStrategy"
        reportObjects:
          $ref: "#/components/schemas/reportObjectLabels"
        timeout:
          $ref: "#/components/schemas/jobTimeout"
        wait:
          $ref: "#/components/schemas/waitSeconds"
        version:
          type: integer
          description: Version of this request object, which is currently version 1.
      example:
        resultFolder: /folders/folders/01234567-0123-0123-0123-0123456789ab
        resultFileName: Status Report Package
        nameConflict: replace
        wait: 10
        timeout: 300
        reportObjects:
          - Bar Graph 1
          - Table of Frequencies
        version: 1
    exportImageRequest:
      type: object
      description: Information about the image that is to be exported. It is to be determined whether the entire body is optional, since in the first iteration of this operation, defaults can be supplied by the system for all of the fields.  If an empty body is supplied in the request, a representative normal layout image of the default size is rendered of the first page of the report. The report is saved with a generated name in the personal folder of the caller's identity.
      x-sas-media-type:
        name: application/vnd.sas.visual.analytics.report.export.image.request
        version: 1
      required:
        - image
        - version
      properties:
        resultFolder:
          $ref: "#/components/schemas/resultFolder"
        resultFilename:
          $ref: "#/components/schemas/resultFilename"
        nameConflict:
          $ref: "#/components/schemas/replacementStrategy"
        reportObject:
          $ref: "#/components/schemas/reportObjectLabelForImage"
        image:
          $ref: "#/components/schemas/exportImageOptions"
        timeout:
          $ref: "#/components/schemas/jobTimeout"
        wait:
          $ref: "#/components/schemas/waitSeconds"
        version:
          type: integer
          description: Version of this request object, which is currently version 1.
    exportDataRequest:
      type: object
      description: Information about visual element data that is to be exported. The reportObject property is required to export information about the underlying data. <p> If the folder is not specified, the package is retained for a time, but will not be visible in file selection windows, such as in SAS Drive. It is cached temporarily by the Report Data service for a period of time sufficient for clients to check the status of the package job and download it.
      x-sas-media-type:
        name: application/vnd.sas.visual.analytics.report.export.data.request
        version: 1
      required:
        - format
        - reportObject
        - version
      properties:
        format:
          type: string
          enum:
            - csv
            - tsv
            - xlsx
          default: xlsx
          description: The format of the data file that will be exported.  May be comma-separated values, tab-separated values, or an excel spreadsheet.  The excel option does not provided special visual formatting of the data as a table, such as fonts and colors.  It outputs only rows and columns of values. Individual data values are formatted according to their definitions in the original data sets or by the report author's data format selections.
        reportObject:
          type: string
          description: Visual element name or label
        resultFolder:
          $ref: "#/components/schemas/resultFolder"
        resultFilename:
          $ref: "#/components/schemas/resultFilename"
        nameConflict:
          $ref: "#/components/schemas/replacementStrategy"
        timeout:
          $ref: "#/components/schemas/jobTimeout"
        wait:
          $ref: "#/components/schemas/waitSeconds"
        options:
          $ref: "#/components/schemas/exportDataOptions"
        version:
          type: integer
          description: Version of this request object, which is currently version 1.
    jobTimeout:
      type: integer
      example: 60
      description: After creation of the job, the maximum number of seconds it will be allowed to run before timing out.  The default maximum is a system configuration value. This option allows the maximum to be modified for this request, but its value cannot exceed a system-configured maximum limit.  There is no guarantee that all background processes can be terminated when time-out is exceeded, but an attempt will be made where it is possible.
    waitSeconds:
      type: integer
      example: 30
      description: Number of seconds to wait before returning from the initial POST to start the job. The default value is effectively zero, meaning to return the running job to the client as soon as it is created. Specifying a positive value instructs the server to wait on the running job for the specified number of seconds because the client expects the job to finish quickly. This allows the client to avoid having to poll for completion. It should be used cautiously because job durations are unpredictable.
    resultFilename:
      description: The user-visible file name of the output when it is saved in a folder on the server. If the resultFolder is provided and no resultFilename is specified on the request, the service gives the file a default name. On a running or completed job, the file name is either the requested name, optionally modified by the system to avoid name conflicts, or if the request specified no file name, it is the name generated by the system.
      type: string
      example: Sample Output File Name.svg
    resultFolder:
      type: string
      description: The URI of the folder in which the output file should be created.  Specifying a folder URI allows the result to be visible in user interfaces that show files, and it puts the lifetime of the result file in the control of the client.  If the result folder is not specified, the result file is transient; the system can clean up results on its own schedule, and it retains control of the lifetime of the file. The client can specify placeholder "/folders/folders/@myFolder" to save it in the user's personal folder. If the folder is specified and does not exist, it is an error.
    exportImageOptions:
      type: object
      description: Values needed for rendering the image.
      required:
        - format
        - size
      properties:
        format:
          type: string
          enum:
            - svg
            - png
          description: The type of image that is output, which initially can only be scalable vector graphic format. This property must be provided. Accepts "svg" and "png" as the allowed value.
        size:
          type: string
          example: 1234px,2313px
          description: Size of the resulting image in the form "9999px,9999px", where the horizontal dimension is before the comma and the vertical dimension is afterward. The size must be specified. The two characters after the digits are reserved for unit specifiers; for example, "1024px,768px".  The only units currently supported are pixels ("px") but the unit must be specified.
    exportDataOptions:
      type: object
      description: "Options for generating and downloading a data file in one of several formats. Supported formats are csv, tsv and xlsx. "
      properties:
        startRow:
          type: integer
          default: 0
          description: Start row to export. Default is 0
        endRow:
          type: integer
          default: -1
          description: End Row inclusive to be exported. Default is -1 for all the rows
        columns:
          type: array
          description: "Data items to be exported. "
        formattedData:
          type: boolean
          default: true
          description: Indicates whether the exported data should reflect any formats applied on the data item. Default is true
        detailedData:
          type: boolean
          default: false
          description: >
            Indicates whether the exported data should be detailed data. Default is false
    exportPdfOptions:
      type: object
      description: Options for executing the action.  May describe output characteristics or control parameters. Not all properties are applicable to every action.
      properties:
        orientation:
          type: string
          enum:
            - landscape
            - portrait
          default: landscape
          description: The page orientation. Applicable to PDF rendering.
        paperSize:
          $ref: "#/components/schemas/paperSize"
        margin:
          $ref: "#/components/schemas/margin"
        includeTableOfContents:
          type: boolean
          default: false
          description: Indicates whether to generate a printed table of contents.
        showPageNumbers:
          type: boolean
          default: true
          description: Indicates whether page numbers should be displayed.
        showEmptyRowsAndColumns:
          type: boolean
          default: false
          description: Indicates whether empty rows and columns should be included to fill the allocated layout space for tables and crosstabs.
        includeAppendix:
          type: boolean
          default: true
          description: Indicates whether the appendix should be included.
        includeComments:
          type: boolean
          default: false
          description: Indicates whether the comments should be included in the appendix.
        includeDetailsTables:
          type: boolean
          default: false
          description: Indicates whether the comments should be included in the appendix.
        expandClippedContent:
          type: boolean
          default: false
          description: Enables you to see all of the content for tables, crosstabs, gauges, and containers. This includes content that is only partially available in the layout of the page. Each object is displayed on a separate page at the end of the report.
        includeCoverPage:
          type: boolean
          default: true
          description: Indicates whether a cover page should be included.
        coverPageText:
          type: string
          default: ""
          description: Optional text to be included on the cover page. This setting is ignored if includeCoverPage is false.
    exportPdfJob:
      type: object
      description: An object representing a job that is run asynchronously for this service.
      x-sas-media-type:
        name: application/vnd.sas.visual.analytics.report.export.pdf.job
        version: 1
      required:
        - id
        - state
      properties:
        id:
          type: string
          description: The identifier of the action job, usually a UUID, generated by the service.
        state:
          $ref: "#/components/schemas/jobState"
        inputReport:
          $ref: "#/components/schemas/jobInputReport"
        reportObjects:
          $ref: "#/components/schemas/reportObjectLabels"
        resultFolder:
          $ref: "#/components/schemas/resultFolder"
        resultFilename:
          $ref: "#/components/schemas/resultFilename"
        nameConflict:
          $ref: "#/components/schemas/replacementStrategy"
        resultMediaType:
          $ref: "#/components/schemas/resultMediaType"
        creationTimestamp:
          $ref: "#/components/schemas/creationTimestamp"
        endTimestamp:
          $ref: "#/components/schemas/endTimestamp"
        links:
          $ref: "#/components/schemas/exportJobLinks"
        version:
          type: integer
          description: Version of this export job, which is currently version 1.
      example:
        id: 12345678-abcd-ef12-3456-12345678abab
        state: running
        inputReport: /reports/reports/12345678-abcd-ef12-3456-12345678abcd
        reportObjects:
          - Bar Graph 1
          - Table of Frequencies
        resultFolder: /folders/folders/01234567-0123-0123-0123-0123456789ab
        resultFileName: Status Report Final
        nameConflict: replace
        resultMediaType: application/pdf
        creationTimeStamp: 2021-06-21T21:10:31.123Z
        endTimeStamp: 2021-06-21T21:10:41.123Z
        links:
          - rel: self
            method: GET
            type: application/vnd.sas.visual.analytics.report.export.pdf.job
            uri: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
            href: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
          - rel: result
            method: GET
            type: application/*
            uri: /files/files/12345678-1234-1234-1234-123456789abc/content
            href: /files/files/12345678-1234-1234-1234-123456789abc/content
          - rel: delete
            method: DELETE
            uri: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
            href: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
          - rel: deleteContent
            method: DELETE
            uri: /files/files/12345678-1234-1234-1234-123456789abc
            href: /files/files/12345678-1234-1234-1234-123456789abc
        version: 1
    exportPackageJob:
      type: object
      description: An object representing a job that is run asynchronously for this service.
      x-sas-media-type:
        name: application/vnd.sas.visual.analytics.report.export.package.job
        version: 1
      properties:
        id:
          type: string
          description: The identifier of the action job, usually a UUID, generated by the service.
        state:
          $ref: "#/components/schemas/jobState"
        inputReport:
          $ref: "#/components/schemas/jobInputReport"
        reportObjects:
          $ref: "#/components/schemas/reportObjectLabels"
        resultFolder:
          $ref: "#/components/schemas/resultFolder"
        resultFileName:
          $ref: "#/components/schemas/resultFilename"
        nameConflict:
          $ref: "#/components/schemas/replacementStrategy"
        resultMediaType:
          $ref: "#/components/schemas/resultMediaType"
        creationTimestamp:
          $ref: "#/components/schemas/creationTimestamp"
        endTimestamp:
          $ref: "#/components/schemas/endTimestamp"
        links:
          $ref: "#/components/schemas/exportJobLinks"
        version:
          type: integer
          description: Version of this export job, which is currently version 1.
      example:
        id: 12345678-1234-1234-1234-123456789abc
        state: running
        inputReport: /reports/reports/12345678-abcd-ef12-3456-12345678abcd
        reportObjects:
          - Bar Graph 1
          - Table of Frequencies
        resultFolder: /folders/folders/01234567-0123-0123-0123-0123456789ab
        resultFileName: Status Report Package
        nameConflict: replace
        resultMediaType: application/zip
        creationTimeStamp: 2021-06-21T21:10:31.123Z
        endTimeStamp: 2021-06-21T21:10:41.123Z
        links:
          - rel: self
            method: GET
            type: application/vnd.sas.visual.analytics.report.export.package.job
            uri: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
            href: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
          - rel: result
            method: GET
            type: application/*
            uri: /files/files/12345678-1234-1234-1234-123456789abc/content
            href: /files/files/12345678-1234-1234-1234-123456789abc/content
          - rel: delete
            method: DELETE
            uri: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
            href: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
          - rel: deleteContent
            method: DELETE
            uri: /files/files/12345678-1234-1234-1234-123456789abc
            href: /files/files/12345678-1234-1234-1234-123456789abc
        version: 1
    exportImageJob:
      type: object
      description: An object representing a job that is run asynchronously for this service.
      x-sas-media-type:
        name: application/vnd.sas.visual.analytics.report.export.image.job
        version: 1
      required:
        - id
        - state
      properties:
        id:
          type: string
          description: The identifier of the action job, usually a UUID, generated by the service.
        state:
          $ref: "#/components/schemas/jobState"
        inputReport:
          $ref: "#/components/schemas/jobInputReport"
        reportObject:
          type: string
          description: Visual element name or label
        resultMediaType:
          $ref: "#/components/schemas/resultMediaType"
        creationTimestamp:
          $ref: "#/components/schemas/creationTimestamp"
        endTimestamp:
          $ref: "#/components/schemas/endTimestamp"
        links:
          $ref: "#/components/schemas/exportImageJobLinks"
        version:
          type: integer
          description: Version of this export job, which is currently version 1.
    exportDataJob:
      type: object
      description: An object representing a job that is run asynchronously for this service.
      x-sas-media-type:
        name: application/vnd.sas.visual.analytics.report.export.data.job
        version: 1
      required:
        - id
      properties:
        id:
          type: string
          description: The identifier of the action job, usually a UUID, generated by the service.
        state:
          $ref: "#/components/schemas/jobState"
        inputReport:
          $ref: "#/components/schemas/jobInputReport"
        reportObject:
          type: string
          description: Visual element name or label
        resultFolder:
          $ref: "#/components/schemas/resultFolder"
        resultFilename:
          $ref: "#/components/schemas/resultFilename"
        resultMediaType:
          $ref: "#/components/schemas/resultMediaType"
        nameConflict:
          $ref: "#/components/schemas/replacementStrategy"
        creationTimestamp:
          $ref: "#/components/schemas/creationTimestamp"
        endTimestamp:
          $ref: "#/components/schemas/endTimestamp"
        links:
          $ref: "#/components/schemas/exportJobLinks"
        version:
          type: integer
          description: Version of this export job, which is currently version 1.
    resultMediaType:
      type: string
      example: application/svg
      description: The expected media type for the final output of the job. This is not the media type of the initial response object from starting an asynchronous job; rather, the final output has a media type like `image/svg+xml`, `text/csv` or `application/pdf`.
    jobInputReport:
      type: string
      example: /reports/reports/cbf97b0a-457d-4b4f-8913-547e0cdf390c
      description: The input resource URI report for the action job.  This is copied from the export request's report information, specifically the report id in the request path.
    exportJobLinks:
      description: The links to get further status or results of the export job.  The expected link relations are "self", "delete", "result", and "deleteContent". The `self` link is used to requery the state of the running job. The result link is present only if the job completed and produced a result file that can be downloaded. The "deleteContent" is present only if result content is deletable by the client.
      type: array
      items:
        $ref: "#/components/schemas/link"
      example:
        - rel: self
          links:
            - rel: self
              method: GET
              type: application/vnd.sas.visual.analytics.report.export.*.job
              uri: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
              href: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
            - rel: result
              method: GET
              type: application/*
              uri: /files/files/12345678-1234-1234-1234-123456789abc/content
              href: /files/files/12345678-1234-1234-1234-123456789abc/content
            - rel: delete
              method: DELETE
              uri: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
              href: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
            - rel: deleteContent
              method: DELETE
              uri: /files/files/12345678-1234-1234-1234-123456789abc
              href: /files/files/12345678-1234-1234-1234-123456789abc
    exportImageJobLinks:
      description: The links to get further status or results of the image export job. The expected link relations are "self", "delete", "result". The `self` link is used to requery the state of the running job. The result link is present only if the job completed and produced a result file that can be downloaded.
      type: array
      items:
        $ref: "#/components/schemas/link"
      example:
        - rel: self
          method: GET
          type: application/vnd.sas.visual.analytics.report.export.image.job
          uri: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
          href: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
        - rel: result
          method: GET
          type: image/svg+xml
          uri: /serviceName/collectionName/12345678-1234-1234-1234-123456789abc
          href: /serviceName/collectionName/12345678-1234-1234-1234-123456789abc
        - rel: delete
          method: DELETE
          uri: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
          href: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
    creationTimestamp:
      type: string
      description: Timestamp when job began processing.   It is in the standard internet format.
      format: date-time
    endTimestamp:
      type: string
      description: Depending on whether the job stopped or is still running, the meaning varies. If the job completed, it is the time at which the job stopped. If the job is still running, it is the time at which the job is stopped, calculated from the time of the original export request and the value of the "timeout" duration. It is in the standard internet format.
      format: date-time
    jobState:
      description: Status of the overall job. If multiple results were requested, each individual result contains a separate status set.
      type: string
      enum:
        - running
        - completed
        - failed
    reportObjectDescriptor:
      x-sas-media-type:
        name: application/vnd.sas.visual.analytics.report.object.descriptor
        version: 1
      description: A minimal set of properties describing a report object. Useful for obtaining the correct information needed to refer to the objects in API parameters.
      properties:
        version:
          type: integer
          description: Version 1.
        objectType:
          type: string
          enum:
            - graph
            - table
            - crosstab
            - image
            - text
            - container
            - page
          description: One of several types of report object that are useful to the user.
        label:
          type: string
          description: The user-visible name of the object.
        name:
          type: string
          description: The internal name of the object, which can be useful in some contexts. Has a more constrained format than the label, and is unique within the scope of the report.
        index:
          type: integer
          description: Useful only for page objects. Indicates the position of a page in the visible sequence of pages when the report is viewed. The index is zero-based.
      example:
        objectType: graph
        label: Bar Graph of Revenue - 1
        name: ve233
        index: 0
        version: 1
    reportObjectCollection:
      x-sas-media-type:
        name: application/vnd.sas.collection
        version: 2
      description: A standard collection or list of descriptor objects that contain key information about the visible objects in a report, such as tables, crosstabs, graphs, etc.
      properties:
        name:
          type: string
          description: The name of the collection in the context of the request.  This property is of minimal use to the client.
        start:
          type: integer
          description: The 0-based index of the result candidates to start returning.
        limit:
          type: integer
          description: The maximum number of results requested.
        count:
          type: integer
          description: The total number of unpaged results available.
        accept:
          type: string
          enum:
            - application/json
            - application/vnd.sas.visual.analytics.report.object.descriptor+json
          description: The accept-item header value that was used in the initial request.
        links:
          type: array
          description: Paging links that apply to this object
          items:
            $ref: "#/components/schemas/link"
        items:
          type: array
          description: The actual results of a query
          items:
            $ref: "#/components/schemas/reportObjectDescriptor"
        version:
          type: integer
          description: collection schema version
    link:
      title: Link
      type: object
      description: A link to a related operation or resource.
      required:
        - rel
      properties:
        method:
          type: string
          description: The HTTP method for the link.
        rel:
          type: string
          description: The relationship of the link to the resource.
        uri:
          type: string
          description: The relative URI for the link.
        href:
          type: string
          description: The URL for the link.
        title:
          type: string
          description: The title for the link.
        type:
          type: string
          description: The media type or link type for the link.
        itemType:
          type: string
          description: If this is a link to a container, `itemType` is the media type or link type for the items in the container.
        responseType:
          type: string
          description: The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.
        responseItemType:
          type: string
          description: The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.
    apiList:
      type: object
      description: The standard object for the top level resource of the service.  Contains a list of link objects.
      x-sas-media-type:
        name: application/vnd.sas.api
        version: 1
      properties:
        version:
          type: integer
          description: The version number of the API representation. This is version 1.
          minimum: 1
        links:
          description: The API's top-level links.
          type: array
          items:
            $ref: "#/components/schemas/link"
      example:
        version: 1
        links:
          - rel: self
            method: GET
            type: application/vnd.sas.api
            uri: /visualAnalytics
            href: /visualAnalytics
          - rel: printReport
            method: GET
            type: application/zip
            uri: /visualAnalytics/reports/{reportId}/pdf
            href: /visualAnalytics/reports/{reportId}/pdf
          - rel: reportPackage
            method: GET
            type: application/zip
            uri: /visualAnalytics/reports/{reportId}/package
            href: /visualAnalytics/reports/{reportId}/package
          - rel: reportImageSvg
            method: GET
            type: image/svg+xml
            uri: /visualAnalytics/reports/{reportId}/svg
            href: /visualAnalytics/reports/{reportId}/svg
          - rel: reportImagePng
            method: GET
            type: image/png
            uri: /visualAnalytics/reports/{reportId}/png
            href: /visualAnalytics/reports/{reportId}/png
          - rel: reportDataCsv
            method: GET
            type: text/csv
            uri: /visualAnalytics/reports/{reportId}/csv
            href: /visualAnalytics/reports/{reportId}/csv
          - rel: exportPdf
            method: POST
            type: application/vnd.sas.visual.analytics.report.export.pdf.request
            responseType: application/vnd.sas.visual.analytics.report.export.pdf.job
            uri: /visualAnalytics/reports/{reportId}/exportPdf
            href: /visualAnalytics/reports/{reportId}/exportPdf
    error2:
      title: Error
      type: object
      description: The representation of an error.
      x-sas-media-type:
        name: application/vnd.sas.error
        version: 2
      required:
        - httpStatusCode
        - version
      properties:
        message:
          type: string
          description: The message for the error.
        id:
          type: string
          description: The string ID for the error.
        errorCode:
          type: integer
          description: The numeric ID for the error.
        httpStatusCode:
          type: integer
          description: The HTTP status code for the error.
        details:
          type: array
          description: Messages that provide additional details about the cause of the error.
          items:
            type: string
        remediation:
          type: string
          description: A message that describes how to resolve the error.
        errors:
          type: array
          description: Any additional errors that occurred.
          items:
            $ref: "#/components/schemas/error2"
        links:
          type: array
          description: The links that apply to the error.
          items:
            $ref: "#/components/schemas/link"
        version:
          type: integer
          description: The version number of the error representation. This representation is version 2.
    response:
      description: >
        This object represents the response to a request and contains the individual responses for each of the requested operations.
      properties:
        id:
          type: string
          description: The id of the request, usually a UUID.
        version:
          type: integer
          description: This media type's schema version number.
        resultReportId:
          type: string
          description: The resulting report id if a new report was requested.
        resultReportName:
          type: string
          description: The resulting report name if a new report was requested. This name may be different than the name requested if a name conflict occurs and the reportNameConflict option was specified as "rename".
        resultReportUri:
          type: string
          description: The resulting report uri if a new report was requested.
        resultFolderUri:
          type: string
          description: The folder uri containing the resulting report if a new report was requested.
        operations:
          description: An array of responses for the operations that were performed. This array of responses is a one to one mapping of the operations in the request.
          type: array
          items:
            $ref: "#/components/schemas/operationResponse"
        status:
          description: The status, such as success or failure.
          type: string
        messages:
          description: Messages associated with the results of the request.
          type: array
          items:
            type: string
    request:
      description: >
        A request object is the root object contained in the body of requests for put and post endpoints. It specifies the destination of the resulting report as well as the operations to be performed on the report.
      properties:
        id:
          description: The id of the request, usually a UUID.
          type: string
        version:
          description: This media type's schema version number.
          type: integer
        resultFolder:
          description: The URI of the folder in which to save the resulting report. If not specified and a new report is being created, the default value of "/reports/reports/@myFolder" is used.
          type: string
        resultReportName:
          description: The name of the resulting report. If not specified and a new report is being created, the default value of "Report" is used along with a resultNameConflict policy of "rename".
          type: string
        resultNameConflict:
          description: The name conflict resolution strategy. If not specified, the default behavior of "abort" is used when updating a report and the default behavior of "rename" is used when creating a new report.
          type: string
          enum:
            - abort
            - rename
            - replace
        operations:
          type: array
          items:
            $ref: "#/components/schemas/operation"
    operation:
      description: This object defines a single operation to be performed on a report.
      allOf:
        - type: object
          properties:
            operationId:
              type: string
            includeObjectInResponse:
              type: boolean
        - anyOf:
            - $ref: "#/components/schemas/addDataOperationRequest"
            - $ref: "#/components/schemas/changeDataOperationRequest"
            - $ref: "#/components/schemas/applyDataViewOperationRequest"
            - $ref: "#/components/schemas/addPageOperationRequest"
            - $ref: "#/components/schemas/addObjectOperationRequest"
            - $ref: "#/components/schemas/setParameterValueOperationRequest"
    operationResponse:
      description: The response to an operation being performed.
      allOf:
        - anyOf:
            - $ref: "#/components/schemas/addDataOperationResponse"
            - $ref: "#/components/schemas/changeDataOperationResponse"
            - $ref: "#/components/schemas/applyDataViewOperationResponse"
            - $ref: "#/components/schemas/addPageOperationResponse"
            - $ref: "#/components/schemas/addObjectOperationResponse"
            - $ref: "#/components/schemas/setParameterValueOperationResponse"
        - type: object
          properties:
            status:
              description: Status of the operation
              type: string
            messages:
              description: Individual messages associated with the status.
              type: array
              items:
                description: A message
                type: string
    changeDataOperationResponse:
      description: Operation reponse for changing a data source on a report
      properties:
        name:
          description: The name for the data changed
          type: string
        label:
          description: The label for the data changed
          type: string
        data:
          $ref: "#/components/schemas/data"
    addObjectOperationRequest:
      description: Operation to add an object to a report
      properties:
        addObject:
          $ref: "#/components/schemas/addObjectRequest"
    addDataOperationResponse:
      description: Operation reponse for adding a data source to a report
      properties:
        name:
          description: The name for the data added
          type: string
        label:
          description: The label for the data added
          type: string
        data:
          $ref: "#/components/schemas/data"
    applyDataViewOperationRequest:
      description: Operation to apply a data view to a report
      properties:
        applyDataView:
          $ref: "#/components/schemas/applyDataViewRequest"
    addDataOperationRequest:
      description: Operation to add a data source to a report
      properties:
        addData:
          $ref: "#/components/schemas/addDataRequest"
    applyDataViewOperationResponse:
      description: Operation reponse for applying a data view to a report
      properties:
        name:
          description: The name for the data that was changed
          type: string
        label:
          description: The label for the data that was changed
          type: string
        data:
          $ref: "#/components/schemas/data"
    addPageOperationResponse:
      description: Operation response for adding a page to a report
      properties:
        name:
          description: The name for the page added
          type: string
        label:
          description: The label for the page added
          type: string
    addPageOperationRequest:
      description: Operation to add a page to a report
      properties:
        addPage:
          $ref: "#/components/schemas/addPageRequest"
    setParameterValueOperationRequest:
      description: Operation to set a parameter value on a report
      properties:
        setParameterValue:
          $ref: "#/components/schemas/setParameterValueRequest"
    setParameterValueOperationResponse:
      description: Operation response for setting a parameter value on a report
      properties:
        name:
          description: The name of the parameter
          type: string
        value:
          description: The new value for the parameter
          type: string
        parameter:
          $ref: "#/components/schemas/parameter"
    addObjectOperationResponse:
      description: Operation response for adding an object to a report
      properties:
        name:
          description: The name for the object added
          type: string
        label:
          description: The label for the object added
          type: string
        object:
          $ref: "#/components/schemas/object"
    changeDataOperationRequest:
      description: Operation to change a data source on a report
      properties:
        changeData:
          $ref: "#/components/schemas/changeDataRequest"
    changeDataRequest:
      description: Representation of a change data operation on a request.
      type: object
      required:
        - originalData
        - replacementData
      properties:
        originalData:
          description: The original data on the report to be changed
          type: object
          properties:
            cas:
              $ref: "#/components/schemas/cas"
        replacementData:
          description: The replacement data for the report
          type: object
          properties:
            cas:
              $ref: "#/components/schemas/cas"
        forceReplace:
          description: When the replacement data is tested for compatibility and errors occur, the operation can either fail or attempt to continue. This property can be used to force the change even if errors are found.
          type: boolean
        replacementLabel:
          description: A new label for the data source
          type: string
        replacementDataItems:
          description: Replacement names for individual data items when mapping data. For a data item to be replaced, exactly one of the original name or original column is required. If both are specified, it is not an error, but the behavior is at the discretion of the operation.
          type: array
          items:
            description: The array of data item mapping information.
            type: object
            required:
              - replacementColumn
            properties:
              replacementColumn:
                description: The column name of the replacement column
                type: string
              originalColumn:
                description: The column name of the original data to be replaced
                type: string
              originalName:
                description: The unique name of the original data to be replaced
                type: string
    addDataRequest:
      description: Representation of an add data operation on a request.
      type: object
      required:
        - cas
      properties:
        cas:
          $ref: "#/components/schemas/cas"
    parameter:
      description: The details of the parameter
      type: object
      properties:
        name:
          description: The name of the parameter
          type: string
        label:
          description: The label for the parameter
          type: string
        format:
          description: The format for the parameter
          type: string
        value:
          description: The value for the parameter
          type: string
    data:
      description: Representation of a data source.
      type: object
      required:
        - cas
      properties:
        name:
          description: The name for the data source
          type: string
        label:
          description: The label for the data source
          type: string
        cas:
          $ref: "#/components/schemas/cas"
        items:
          description: The items for this data source.
          type: array
          items:
            $ref: "#/components/schemas/dataItem"
    applyDataViewRequest:
      description: Representation of an apply data view operation on a request.
      type: object
      required:
        - targetData
        - dataView
      properties:
        dataItemConflictResolution:
          description: The data item conflict resolution strategy. If not specified, the default behavior of "abort" is used. The value of 'dataMapping' is not valid when the data view is a data join.
          type: string
          enum:
            - abort
            - createDuplicate
            - replaceExisting
            - keepExisting
            - dataMapping
        targetData:
          description: The target data on the report in which the data view is to be applied
          type: object
          properties:
            cas:
              $ref: "#/components/schemas/cas"
        dataView:
          description: The data view to be applied to the report. Either a data view uri or name is required.
          type: object
          properties:
            uri:
              description: The uri of the data view to be applied to the report
              type: string
            name:
              description: The name of the data view to be applied to the report
              type: string
        dataMapping:
          $ref: "#/components/schemas/dataMappingObject"
    setParameterValueRequest:
      description: Representation of a data source on a request.
      type: object
      required:
        - name
        - value
      properties:
        name:
          description: The parameter name or label
          type: string
        value:
          description: The new parameter value
          type: string
    addPageRequest:
      description: The details of the page.
      type: object
      properties:
        pageName:
          description: The name of the new page.
          type: string
        pagePosition:
          description: The position of the new page on the report.
          type: string
    object:
      description: The object and layout of the object in a report.
      type: object
      required:
        - object
      properties:
        name:
          description: The name of the object.
          type: string
        label:
          description: The label for the object.
          type: string
        object:
          type: object
          oneOf:
            - $ref: "#/components/schemas/standardContainer"
            - $ref: "#/components/schemas/barChart"
            - $ref: "#/components/schemas/treeMap"
            - $ref: "#/components/schemas/targetedBarChart"
            - $ref: "#/components/schemas/needlePlot"
            - $ref: "#/components/schemas/scatterPlot"
            - $ref: "#/components/schemas/heatMap"
            - $ref: "#/components/schemas/keyValue"
            - $ref: "#/components/schemas/gauge"
            - $ref: "#/components/schemas/correlationMatrix"
            - $ref: "#/components/schemas/timeSeriesPlot"
            - $ref: "#/components/schemas/wordCloud"
            - $ref: "#/components/schemas/numericSeriesPlot"
            - $ref: "#/components/schemas/dataDrivenContent"
            - $ref: "#/components/schemas/cluster"
            - $ref: "#/components/schemas/bubblePlot"
            - $ref: "#/components/schemas/waterfallChart"
            - $ref: "#/components/schemas/geoBubble"
            - $ref: "#/components/schemas/geoCluster"
            - $ref: "#/components/schemas/geoContour"
            - $ref: "#/components/schemas/geoCoordinate"
            - $ref: "#/components/schemas/geoPie"
            - $ref: "#/components/schemas/logisticRegression"
            - $ref: "#/components/schemas/parallelCoordinatePlot"
            - $ref: "#/components/schemas/scheduleChart"
            - $ref: "#/components/schemas/stepPlot"
            - $ref: "#/components/schemas/vectorPlot"
            - $ref: "#/components/schemas/bubbleChangePlot"
            - $ref: "#/components/schemas/comparativeTimeSeriesPlot"
            - $ref: "#/components/schemas/butterflyChart"
            - $ref: "#/components/schemas/factorizationMachine"
            - $ref: "#/components/schemas/supportVectorMachine"
            - $ref: "#/components/schemas/dualAxisBarChart"
            - $ref: "#/components/schemas/dualAxisBarLineChart"
            - $ref: "#/components/schemas/dualAxisLineChart"
            - $ref: "#/components/schemas/dualAxisTimeSeriesPlot"
            - $ref: "#/components/schemas/geoRegion"
            - $ref: "#/components/schemas/geoRegionCoordinate"
            - $ref: "#/components/schemas/networkAnalysis"
            - $ref: "#/components/schemas/pathAnalysis"
            - $ref: "#/components/schemas/lineChart"
            - $ref: "#/components/schemas/pieChart"
            - $ref: "#/components/schemas/dotPlot"
            - $ref: "#/components/schemas/boxPlot"
            - $ref: "#/components/schemas/histogram"
            - $ref: "#/components/schemas/listTable"
            - $ref: "#/components/schemas/crosstab"
            - $ref: "#/components/schemas/automatedExplanation"
            - $ref: "#/components/schemas/linearRegression"
            - $ref: "#/components/schemas/forcasting"
            - $ref: "#/components/schemas/buttonBar"
            - $ref: "#/components/schemas/textInput"
            - $ref: "#/components/schemas/dropdownList"
            - $ref: "#/components/schemas/list"
            - $ref: "#/components/schemas/slider"
        layout:
          $ref: "#/components/schemas/layout"
    addObjectRequest:
      description: The object and placement of the object in a report. One of either the object property or the reportObject property are required. Both are not allowed.
      type: object
      properties:
        object:
          type: object
          oneOf:
            - $ref: "#/components/schemas/standardContainerRequest"
            - $ref: "#/components/schemas/barChartRequest"
            - $ref: "#/components/schemas/treeMapRequest"
            - $ref: "#/components/schemas/targetedBarChartRequest"
            - $ref: "#/components/schemas/needlePlotRequest"
            - $ref: "#/components/schemas/scatterPlotRequest"
            - $ref: "#/components/schemas/heatMapRequest"
            - $ref: "#/components/schemas/keyValueRequest"
            - $ref: "#/components/schemas/gaugeRequest"
            - $ref: "#/components/schemas/correlationMatrixRequest"
            - $ref: "#/components/schemas/timeSeriesPlotRequest"
            - $ref: "#/components/schemas/wordCloudRequest"
            - $ref: "#/components/schemas/numericSeriesPlotRequest"
            - $ref: "#/components/schemas/dataDrivenContentRequest"
            - $ref: "#/components/schemas/clusterRequest"
            - $ref: "#/components/schemas/bubblePlotRequest"
            - $ref: "#/components/schemas/waterfallChartRequest"
            - $ref: "#/components/schemas/geoBubbleRequest"
            - $ref: "#/components/schemas/geoClusterRequest"
            - $ref: "#/components/schemas/geoContourRequest"
            - $ref: "#/components/schemas/geoCoordinateRequest"
            - $ref: "#/components/schemas/geoPieRequest"
            - $ref: "#/components/schemas/logisticRegressionRequest"
            - $ref: "#/components/schemas/parallelCoordinatePlotRequest"
            - $ref: "#/components/schemas/scheduleChartRequest"
            - $ref: "#/components/schemas/stepPlotRequest"
            - $ref: "#/components/schemas/vectorPlotRequest"
            - $ref: "#/components/schemas/bubbleChangePlotRequest"
            - $ref: "#/components/schemas/comparativeTimeSeriesPlotRequest"
            - $ref: "#/components/schemas/butterflyChartRequest"
            - $ref: "#/components/schemas/factorizationMachineRequest"
            - $ref: "#/components/schemas/supportVectorMachineRequest"
            - $ref: "#/components/schemas/dualAxisBarChartRequest"
            - $ref: "#/components/schemas/dualAxisBarLineChartRequest"
            - $ref: "#/components/schemas/dualAxisLineChartRequest"
            - $ref: "#/components/schemas/dualAxisTimeSeriesPlotRequest"
            - $ref: "#/components/schemas/geoRegionRequest"
            - $ref: "#/components/schemas/geoRegionCoordinateRequest"
            - $ref: "#/components/schemas/networkAnalysisRequest"
            - $ref: "#/components/schemas/pathAnalysisRequest"
            - $ref: "#/components/schemas/lineChartRequest"
            - $ref: "#/components/schemas/pieChartRequest"
            - $ref: "#/components/schemas/dotPlotRequest"
            - $ref: "#/components/schemas/boxPlotRequest"
            - $ref: "#/components/schemas/histogramRequest"
            - $ref: "#/components/schemas/listTableRequest"
            - $ref: "#/components/schemas/crosstabRequest"
            - $ref: "#/components/schemas/automatedExplanationRequest"
            - $ref: "#/components/schemas/linearRegressionRequest"
            - $ref: "#/components/schemas/forcastingRequest"
            - $ref: "#/components/schemas/buttonBarRequest"
            - $ref: "#/components/schemas/textInputRequest"
            - $ref: "#/components/schemas/dropdownListRequest"
            - $ref: "#/components/schemas/listRequest"
            - $ref: "#/components/schemas/sliderRequest"
        reportObject:
          $ref: "#/components/schemas/reportObjectRequest"
        placement:
          $ref: "#/components/schemas/placement"
    heatMap:
      description: The heatMap details
      type: object
      properties:
        heatMap:
          description: The heatMap details
          type: object
          properties:
            name:
              description: The name of the heatMap.
              type: string
            label:
              description: The label for the heatMap.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    listTableRequest:
      description: The list table details
      properties:
        listTable:
          description: The list table details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                columns:
                  description: The columns for this list table.
                  type: array
                  items:
                    type: string
    bubbleChangePlot:
      description: The bubbleChangePlot details
      type: object
      properties:
        bubbleChangePlot:
          description: The bubbleChangePlot details
          type: object
          properties:
            name:
              description: The name of the bubbleChangePlot.
              type: string
            label:
              description: The label for the bubbleChangePlot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    buttonBarRequest:
      description: The button bar details
      properties:
        buttonBar:
          description: The button bar details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this button bar.
                  type: string
                measure:
                  description: The measure for this button bar.
                  type: string
    keyValueRequest:
      description: The keyValue details
      type: object
      properties:
        keyValue:
          description: The keyValue details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                measure:
                  description: The measure for this keyValue.
                  type: string
                latticeCategory:
                  description: The latticeCategory for this keyValue.
                  type: string
    textInput:
      description: The text input details
      properties:
        textInput:
          description: The text input details
          type: object
          properties:
            name:
              description: The name of the text input.
              type: string
            label:
              description: The label for the text input.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    automatedExplanationRequest:
      description: The automated explanation details
      properties:
        automatedExplanation:
          description: The automated explanation details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                response:
                  description: The response for this automated explanation.
                  type: string
                underlyingFactors:
                  description: The underlying factors for this automated explanation.
                  type: array
                  items:
                    type: string
    needlePlotRequest:
      description: The needlePlot details
      type: object
      properties:
        needlePlot:
          description: The needlePlot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                xAxis:
                  description: The xAxis for this needlePlot.
                  type: string
                yAxis:
                  description: The yAxis for this needlePlot.
                  type: string
                group:
                  description: The group for this needlePlot.
                  type: string
    pieChartRequest:
      description: The pie chart details
      type: object
      properties:
        pieChart:
          description: The pie chart details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this pie chart.
                  type: string
                measures:
                  description: The measures for this pie chart.
                  type: array
                  items:
                    type: string
                frequency:
                  description: The frequency calcualation for this pie chart.
                  type: string
                  enum:
                    - frequency
                    - frequency_percent
    logisticRegression:
      description: The logisticRegression details
      type: object
      properties:
        logisticRegression:
          description: The logisticRegression details
          type: object
          properties:
            name:
              description: The name of the logisticRegression.
              type: string
            label:
              description: The label for the logisticRegression.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    crosstab:
      description: The crosstab details
      properties:
        crosstab:
          description: The crosstab details
          type: object
          properties:
            name:
              description: The name of the crosstab.
              type: string
            label:
              description: The label for the crosstab.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    butterflyChartRequest:
      description: The butterflyChart details
      type: object
      properties:
        butterflyChart:
          description: The butterflyChart details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this butterflyChart.
                  type: string
                measureBar:
                  description: The measureBar for this butterflyChart.
                  type: string
                measureBar2:
                  description: The measureBar2 for this butterflyChart.
                  type: string
    dropdownListRequest:
      description: The dropdown list details
      properties:
        dropdownList:
          description: The dropdown list details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this dropdown list.
                  type: string
                measure:
                  description: The measure for this dropdown list.
                  type: string
    lineChart:
      description: The line chart details
      type: object
      properties:
        lineChart:
          description: The line chart details
          type: object
          properties:
            name:
              description: The name of the line chart.
              type: string
            label:
              description: The label for the line chart.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    cluster:
      description: The cluster details
      type: object
      properties:
        cluster:
          description: The cluster details
          type: object
          properties:
            name:
              description: The name of the cluster.
              type: string
            label:
              description: The label for the cluster.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    dualAxisBarLineChartRequest:
      description: The dualAxisBarLineChart details
      type: object
      properties:
        dualAxisBarLineChart:
          description: The dualAxisBarLineChart details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this dualAxisBarLineChart.
                  type: string
                measureBar:
                  description: The measureBar for this dualAxisBarLineChart.
                  type: string
                measureLine:
                  description: The measureLine for this dualAxisBarLineChart.
                  type: string
    dualAxisTimeSeriesPlot:
      description: The dualAxisTimeSeriesPlot details
      type: object
      properties:
        dualAxisTimeSeriesPlot:
          description: The dualAxisTimeSeriesPlot details
          type: object
          properties:
            response:
              description: The name of the dualAxisTimeSeriesPlot.
              type: string
            label:
              description: The label for the dualAxisTimeSeriesPlot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    targetedBarChartRequest:
      description: The targetedBar Chart details
      type: object
      properties:
        targetedBarChart:
          description: The targetedBar Chart details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this targetedBar Chart.
                  type: string
                measure:
                  description: The measures for this targetedBar Chart.
                  type: string
                  items:
                    type: string
                target:
                  description: The target for this targetedBar Chart.
                  type: string
                  items:
                    type: string
    timeSeriesPlot:
      description: The timeSeriesPlot details
      type: object
      properties:
        timeSeriesPlot:
          description: The timeSeriesPlot details
          type: object
          properties:
            name:
              description: The name of the timeSeriesPlot.
              type: string
            label:
              description: The label for the timeSeriesPlot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    reportObjectRequest:
      description: The details of the reportObject to be added to the report. Either a report object uri or name is required.
      type: object
      allOf:
        - type: object
          properties:
            uri:
              description: The uri of the report object to be added to the report.
              type: string
            name:
              description: The name of the report object to be added to the report.
              type: string
        - oneOf:
            - $ref: "#/components/schemas/barChartRequest"
            - $ref: "#/components/schemas/treeMapRequest"
            - $ref: "#/components/schemas/targetedBarChartRequest"
            - $ref: "#/components/schemas/needlePlotRequest"
            - $ref: "#/components/schemas/scatterPlotRequest"
            - $ref: "#/components/schemas/heatMapRequest"
            - $ref: "#/components/schemas/keyValueRequest"
            - $ref: "#/components/schemas/gaugeRequest"
            - $ref: "#/components/schemas/correlationMatrixRequest"
            - $ref: "#/components/schemas/timeSeriesPlotRequest"
            - $ref: "#/components/schemas/wordCloudRequest"
            - $ref: "#/components/schemas/numericSeriesPlotRequest"
            - $ref: "#/components/schemas/dataDrivenContentRequest"
            - $ref: "#/components/schemas/clusterRequest"
            - $ref: "#/components/schemas/bubblePlotRequest"
            - $ref: "#/components/schemas/waterfallChartRequest"
            - $ref: "#/components/schemas/geoBubbleRequest"
            - $ref: "#/components/schemas/geoClusterRequest"
            - $ref: "#/components/schemas/geoContourRequest"
            - $ref: "#/components/schemas/geoCoordinateRequest"
            - $ref: "#/components/schemas/geoPieRequest"
            - $ref: "#/components/schemas/logisticRegressionRequest"
            - $ref: "#/components/schemas/parallelCoordinatePlotRequest"
            - $ref: "#/components/schemas/scheduleChartRequest"
            - $ref: "#/components/schemas/stepPlotRequest"
            - $ref: "#/components/schemas/vectorPlotRequest"
            - $ref: "#/components/schemas/bubbleChangePlotRequest"
            - $ref: "#/components/schemas/comparativeTimeSeriesPlotRequest"
            - $ref: "#/components/schemas/butterflyChartRequest"
            - $ref: "#/components/schemas/factorizationMachineRequest"
            - $ref: "#/components/schemas/supportVectorMachineRequest"
            - $ref: "#/components/schemas/dualAxisBarChartRequest"
            - $ref: "#/components/schemas/dualAxisBarLineChartRequest"
            - $ref: "#/components/schemas/dualAxisLineChartRequest"
            - $ref: "#/components/schemas/dualAxisTimeSeriesPlotRequest"
            - $ref: "#/components/schemas/geoRegionRequest"
            - $ref: "#/components/schemas/geoRegionCoordinateRequest"
            - $ref: "#/components/schemas/networkAnalysisRequest"
            - $ref: "#/components/schemas/pathAnalysisRequest"
            - $ref: "#/components/schemas/lineChartRequest"
            - $ref: "#/components/schemas/pieChartRequest"
            - $ref: "#/components/schemas/dotPlotRequest"
            - $ref: "#/components/schemas/boxPlotRequest"
            - $ref: "#/components/schemas/histogramRequest"
            - $ref: "#/components/schemas/listTableRequest"
            - $ref: "#/components/schemas/crosstabRequest"
            - $ref: "#/components/schemas/automatedExplanationRequest"
            - $ref: "#/components/schemas/linearRegressionRequest"
            - $ref: "#/components/schemas/forcastingRequest"
            - $ref: "#/components/schemas/buttonBarRequest"
            - $ref: "#/components/schemas/textInputRequest"
            - $ref: "#/components/schemas/dropdownListRequest"
            - $ref: "#/components/schemas/listRequest"
            - $ref: "#/components/schemas/sliderRequest"
    networkAnalysisRequest:
      description: The networkAnalysis details
      type: object
      properties:
        networkAnalysis:
          description: The networkAnalysis details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                source:
                  description: The source for this networkAnalysis.
                  type: string
                target:
                  description: The target for this networkAnalysis.
                  type: string
                size:
                  description: The size for this networkAnalysis.
                  type: string
                color:
                  description: The color for this networkAnalysis.
                  type: string
                linkWidth:
                  description: The linkWidth for this networkAnalysis.
                  type: string
                linkColor:
                  description: The linkColor for this networkAnalysis.
                  type: string
    standardContainer:
      description: The container details
      type: object
      properties:
        standardContainer:
          description: The container details
          type: object
          properties:
            name:
              description: The name of the container.
              type: string
            label:
              description: The label for the container.
              type: string
    pieChart:
      description: The pie chart details
      type: object
      properties:
        pieChart:
          description: The pie chart details
          type: object
          properties:
            name:
              description: The name of the pie chart.
              type: string
            label:
              description: The label for the pie chart.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    standardContainerRequest:
      description: The container details
      type: object
      properties:
        standardContainer:
          description: The container details
          type: object
    scheduleChart:
      description: The scheduleChart details
      type: object
      properties:
        scheduleChart:
          description: The scheduleChart details
          type: object
          properties:
            name:
              description: The name of the scheduleChart.
              type: string
            label:
              description: The label for the scheduleChart.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    dropdownList:
      description: The dropdown list details
      properties:
        dropdownList:
          description: The dropdown list details
          type: object
          properties:
            name:
              description: The name of the dropdown list.
              type: string
            label:
              description: The label for the dropdown list.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    dataItem:
      description: An individual item (or column) for a data source.
      type: object
      oneOf:
        - $ref: "#/components/schemas/categoryDataItem"
        - $ref: "#/components/schemas/measureDataItem"
        - $ref: "#/components/schemas/hierarchyDataItem"
    correlationMatrix:
      description: The correlationMatrix details
      type: object
      properties:
        correlationMatrix:
          description: The correlationMatrix details
          type: object
          properties:
            name:
              description: The name of the correlationMatrix.
              type: string
            label:
              description: The label for the correlationMatrix.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    treeMapRequest:
      description: The treeMap details
      type: object
      properties:
        treeMap:
          description: The treeMap details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this treeMap.
                  type: string
                measure:
                  description: The measure for this treeMap.
                  type: string
                  items:
                    type: string
    dataMappingObject:
      description: The data mapping for a data view that is not a data join. This property is only applicable when the dataItemConflictResolution property is set to 'dataMapping'. It is not valid to use this manual data item mapping when the data view is a data join.
      type: object
      properties:
        dataItemMapping:
          type: array
          items:
            type: object
            required:
              - dataItem
              - applyOption
            properties:
              dataItem:
                description: The data item in the data view for this mapping.
                type: string
              targetDataItem:
                description: The data item to be replaced in the target data. It is required and only applicable for an applyOption of "replace". It is not allowed for an applyOption of "ignore" or "add".
                type: string
              applyOption:
                description: The option used when applying this data item.
                type: string
                enum:
                  - ignore
                  - add
                  - replace
    dualAxisLineChart:
      description: The dualAxisLineChart details
      type: object
      properties:
        dualAxisLineChart:
          description: The dualAxisLineChart details
          type: object
          properties:
            response:
              description: The name of the dualAxisLineChart.
              type: string
            label:
              description: The label for the dualAxisLineChart.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    geoContourRequest:
      description: The geoContour details
      type: object
      properties:
        geoContour:
          description: The geoContour details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                geography:
                  description: The geography for this geoContour.
                  type: string
                color:
                  description: The color for this geoContour.
                  type: string
    factorizationMachineRequest:
      description: The factorizationMachine details
      type: object
      properties:
        factorizationMachine:
          description: The factorizationMachine details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                response:
                  description: The response for this factorizationMachine.
                  type: string
                predictors:
                  description: The predictors for this factorizationMachine.
                  type: array
                  items:
                    type: string
    pathAnalysis:
      description: The pathAnalysis details
      type: object
      properties:
        pathAnalysis:
          description: The pathAnalysis details
          type: object
          properties:
            response:
              description: The name of the pathAnalysis.
              type: string
            label:
              description: The label for the pathAnalysis.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    buttonBar:
      description: The button bar details
      properties:
        buttonBar:
          description: The button bar details
          type: object
          properties:
            name:
              description: The name of the button bar.
              type: string
            label:
              description: The label for the button bar.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    parallelCoordinatePlot:
      description: The parallelCoordinatePlot details
      type: object
      properties:
        parallelCoordinatePlot:
          description: The parallelCoordinatePlot details
          type: object
          properties:
            name:
              description: The name of the parallelCoordinatePlot.
              type: string
            label:
              description: The label for the parallelCoordinatePlot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    vectorPlotRequest:
      description: The vectorPlot details
      type: object
      properties:
        vectorPlot:
          description: The vectorPlot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                xAxis:
                  description: The xAxis for this vectorPlot.
                  type: string
                yAxis:
                  description: The yAxis for this vectorPlot.
                  type: string
                xOrigin:
                  description: The xOrigin for this vectorPlot.
                  type: string
                yOrigin:
                  description: The yOrigin for this vectorPlot.
                  type: string
                color:
                  description: The color for this vectorPlot.
                  type: string
    dualAxisLineChartRequest:
      description: The dualAxisLineChart details
      type: object
      properties:
        dualAxisLineChart:
          description: The dualAxisLineChart details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this dualAxisLineChart.
                  type: string
                measureLine:
                  description: The measureLine for this dualAxisLineChart.
                  type: string
                measureLine2:
                  description: The measureLine2 for this dualAxisLineChart.
                  type: string
    butterflyChart:
      description: The butterflyChart details
      type: object
      properties:
        butterflyChart:
          description: The butterflyChart details
          type: object
          properties:
            name:
              description: The name of the butterflyChart.
              type: string
            label:
              description: The label for the butterflyChart.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    geoCluster:
      description: The geoCluster details
      type: object
      properties:
        geoCluster:
          description: The geoCluster details
          type: object
          properties:
            name:
              description: The name of the geoCluster.
              type: string
            label:
              description: The label for the geoCluster.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    geoRegionCoordinateRequest:
      description: The geoRegionCoordinate details
      type: object
      properties:
        geoRegionCoordinate:
          description: The geoRegionCoordinate details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                geography_region:
                  description: The geography_region for this geoRegionCoordinate.
                  type: string
                color_region:
                  description: The color_region for this geoRegionCoordinate.
                  type: string
                geography_scatter:
                  description: The geography_scatter for this geoRegionCoordinate.
                  type: string
                size_scatter:
                  description: The size_scatter for this geoRegionCoordinate.
                  type: string
                color_scatter:
                  description: The color_scatter for this geoRegionCoordinate.
                  type: string
    boxPlotRequest:
      description: The box plot details
      properties:
        boxPlot:
          description: The box plot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this box plot.
                  type: string
                measures:
                  description: The measures for this box plot.
                  type: array
                  items:
                    type: string
    histogram:
      description: The histogram details
      properties:
        histogram:
          description: The histogram details
          type: object
          properties:
            name:
              description: The name of the histogram.
              type: string
            label:
              description: The label for the histogram.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    wordCloudRequest:
      description: The wordCloud details
      type: object
      properties:
        wordCloud:
          description: The wordCloud details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                word:
                  description: The word for this wordCloud.
                  type: string
                size:
                  description: The size for this wordCloud.
                  type: string
                color:
                  description: The color for this wordCloud.
                  type: string
    parallelCoordinatePlotRequest:
      description: The parallelCoordinatePlot details
      type: object
      properties:
        parallelCoordinatePlot:
          description: The parallelCoordinatePlot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                variables:
                  description: The variables for this parallelCoordinatePlot.
                  type: array
                  items:
                    type: string
    lineChartRequest:
      description: The line chart details
      type: object
      properties:
        lineChart:
          description: The line chart details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this line chart.
                  type: string
                measures:
                  description: The measures for this line chart.
                  type: array
                  items:
                    type: string
                frequency:
                  description: The frequency calcualation for this line chart.
                  type: string
                  enum:
                    - frequency
                    - frequency_percent
    list:
      description: The list details
      properties:
        list:
          description: The list details
          type: object
          properties:
            name:
              description: The name of the list.
              type: string
            label:
              description: The label for the list.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    cas:
      description: The cas data source.
      type: object
      required:
        - table
      properties:
        server:
          description: The name of the server.
          type: string
        library:
          description: The name of the library.
          type: string
        table:
          description: The name of the table.
          type: string
        locale:
          description: The locale for the cas resource (not supported on the request).
          type: string
    barChartRequest:
      description: The bar chart details
      type: object
      properties:
        barChart:
          description: The bar chart details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this bar chart.
                  type: string
                measures:
                  description: The measures for this bar chart.
                  type: array
                  items:
                    type: string
                frequency:
                  description: The frequency calcualation for this bar chart.
                  type: string
                  enum:
                    - frequency
                    - frequency_percent
    boxPlot:
      description: The box plot details
      properties:
        boxPlot:
          description: The box plot details
          type: object
          properties:
            name:
              description: The name of the box plot.
              type: string
            label:
              description: The label for the box plot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    timeSeriesPlotRequest:
      description: The timeSeriesPlot details
      type: object
      properties:
        timeSeriesPlot:
          description: The timeSeriesPlot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                timeAxis:
                  description: The timeAxis for this timeSeriesPlot.
                  type: string
                measure:
                  description: The measure for this timeSeriesPlot.
                  type: string
                group:
                  description: The group for this timeSeriesPlot.
                  type: string
    listRequest:
      description: The list details
      properties:
        list:
          description: The list details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this list.
                  type: string
                measure:
                  description: The measure for this list.
                  type: string
    networkAnalysis:
      description: The networkAnalysis details
      type: object
      properties:
        networkAnalysis:
          description: The networkAnalysis details
          type: object
          properties:
            response:
              description: The name of the networkAnalysis.
              type: string
            label:
              description: The label for the networkAnalysis.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    stepPlot:
      description: The stepPlot details
      type: object
      properties:
        stepPlot:
          description: The stepPlot details
          type: object
          properties:
            name:
              description: The name of the stepPlot.
              type: string
            label:
              description: The label for the stepPlot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    comparativeTimeSeriesPlotRequest:
      description: The comparativeTimeSeriesPlot details
      type: object
      properties:
        comparativeTimeSeriesPlot:
          description: The comparativeTimeSeriesPlot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                timeAxis:
                  description: The timeAxis for this comparativeTimeSeriesPlot.
                  type: string
                measureTimeSeries1:
                  description: The measureTimeSeries1 for this comparativeTimeSeriesPlot.
                  type: string
                measureTimeSeries2:
                  description: The measureTimeSeries2 for this comparativeTimeSeriesPlot.
                  type: string
    geoCoordinate:
      description: The geoCoordinate details
      type: object
      properties:
        geoCoordinate:
          description: The geoCoordinate details
          type: object
          properties:
            name:
              description: The name of the geoCoordinate.
              type: string
            label:
              description: The label for the geoCoordinate.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    wordCloud:
      description: The wordCloud details
      type: object
      properties:
        wordCloud:
          description: The wordCloud details
          type: object
          properties:
            name:
              description: The name of the wordCloud.
              type: string
            label:
              description: The label for the wordCloud.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    stepPlotRequest:
      description: The stepPlot details
      type: object
      properties:
        stepPlot:
          description: The stepPlot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                xAxis:
                  description: The xAxis for this stepPlot.
                  type: string
                yAxis:
                  description: The yAxis for this stepPlot.
                  type: string
                group:
                  description: The group for this stepPlot.
                  type: string
    dataDrivenContentRequest:
      description: The dataDrivenContent details
      type: object
      properties:
        dataDrivenContent:
          description: The dataDrivenContent details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                variables:
                  description: The variables for this dataDrivenContent.
                  type: array
                  items:
                    type: string
    forcastingRequest:
      description: The forcasting details
      properties:
        forcasting:
          description: The forcasting details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                timeAxis:
                  description: The time axis for this forcasting object.
                  type: string
                measures:
                  description: The measures for this forcasting object.
                  type: array
                  items:
                    type: string
                underlyingFactors:
                  description: The underlying factors for this forcasting object.
                  type: array
                  items:
                    type: string
    slider:
      description: The slider details
      properties:
        slider:
          description: The slider details
          type: object
          properties:
            name:
              description: The name of the slider.
              type: string
            label:
              description: The label for the slider.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    gaugeRequest:
      description: The gauge details
      type: object
      properties:
        gauge:
          description: The gauge details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this gauge.
                  type: string
                target:
                  description: The target for this gauge.
                  type: string
                group:
                  description: The group for this gauge.
                  type: string
    comparativeTimeSeriesPlot:
      description: The comparativeTimeSeriesPlot details
      type: object
      properties:
        comparativeTimeSeriesPlot:
          description: The comparativeTimeSeriesPlot details
          type: object
          properties:
            name:
              description: The name of the comparativeTimeSeriesPlot.
              type: string
            label:
              description: The label for the comparativeTimeSeriesPlot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    needlePlot:
      description: The needlePlot details
      type: object
      properties:
        needlePlot:
          description: The needlePlot details
          type: object
          properties:
            name:
              description: The name of the needlePlot.
              type: string
            label:
              description: The label for the needlePlot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    correlationMatrixRequest:
      description: The correlationMatrix details
      type: object
      properties:
        correlationMatrix:
          description: The correlationMatrix details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                measures:
                  description: The measures for this correlationMatrix. Minimum two items.
                  type: array
                  items:
                    type: string
    textInputRequest:
      description: The text input details
      properties:
        textInput:
          description: The text input details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this text input.
                  type: string
                measure:
                  description: The measure for this text input.
                  type: string
    treeMap:
      description: The treeMap details
      type: object
      properties:
        treeMap:
          description: The treeMap details
          type: object
          properties:
            name:
              description: The name of the treeMap.
              type: string
            label:
              description: The label for the treeMap.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    geoBubble:
      description: The geoBubble details
      type: object
      properties:
        geoBubble:
          description: The geoBubble details
          type: object
          properties:
            name:
              description: The name of the geoBubble.
              type: string
            label:
              description: The label for the geoBubble.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    geoBubbleRequest:
      description: The geoBubble details
      type: object
      properties:
        geoBubble:
          description: The geoBubble details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                geography:
                  description: The geography for this geoBubble.
                  type: string
                size:
                  description: The size for this geoBubble.
                  type: string
                color:
                  description: The color for this geoBubble.
                  type: string
    geoCoordinateRequest:
      description: The geoCoordinate details
      type: object
      properties:
        geoCoordinate:
          description: The geoCoordinate details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                geography:
                  description: The geography for this geoCoordinate.
                  type: string
                size:
                  description: The size for this geoCoordinate.
                  type: string
                color:
                  description: The color for this geoCoordinate.
                  type: string
    bubblePlot:
      description: The bubblePlot details
      type: object
      properties:
        bubblePlot:
          description: The bubblePlot details
          type: object
          properties:
            name:
              description: The name of the bubblePlot.
              type: string
            label:
              description: The label for the bubblePlot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    placement:
      description: The placement of the object in the report
      type: object
      oneOf:
        - $ref: "#/components/schemas/reportPlacement"
        - $ref: "#/components/schemas/pagePlacement"
        - $ref: "#/components/schemas/containerPlacement"
        - $ref: "#/components/schemas/relativeToObjectPlacement"
    histogramRequest:
      description: The histogram details
      properties:
        histogram:
          description: The histogram details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                measure:
                  description: The measure for this histogram.
                  type: string
                frequency:
                  description: The frequency calcualation for this histogram.
                  type: string
                  enum:
                    - frequency
                    - frequency_percent
    dataDrivenContent:
      description: The dataDrivenContent details
      type: object
      properties:
        dataDrivenContent:
          description: The dataDrivenContent details
          type: object
          properties:
            name:
              description: The name of the dataDrivenContent.
              type: string
            label:
              description: The label for the dataDrivenContent.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    numericSeriesPlotRequest:
      description: The numericSeriesPlot details
      type: object
      properties:
        numericSeriesPlot:
          description: The numericSeriesPlot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                xAxis:
                  description: The xAxis for this numericSeriesPlot.
                  type: string
                yAxis:
                  description: The yAxis for this numericSeriesPlot.
                  type: string
                group:
                  description: The group for this numericSeriesPlot.
                  type: string
    keyValue:
      description: The keyValue details
      type: object
      properties:
        keyValue:
          description: The keyValue details
          type: object
          properties:
            name:
              description: The name of the keyValue.
              type: string
            label:
              description: The label for the keyValue.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    vectorPlot:
      description: The vectorPlot details
      type: object
      properties:
        vectorPlot:
          description: The vectorPlot details
          type: object
          properties:
            name:
              description: The name of the vectorPlot.
              type: string
            label:
              description: The label for the vectorPlot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    layout:
      description: The layout for an object in a report
      type: object
      properties:
        width:
          description: The width
          type: string
        height:
          description: The height
          type: string
        extendWidthIfAvailable:
          description: Extend the width if space is available?
          type: boolean
        shrinkWidthIfNecessary:
          description: Extend the width if necessary?
          type: boolean
        extendHeightIfAvailable:
          description: Extend the height if space is available?
          type: boolean
        extendHeightIfNecessary:
          description: Extend the height if necessary?
          type: boolean
    bubblePlotRequest:
      description: The bubblePlot details
      type: object
      properties:
        bubblePlot:
          description: The bubblePlot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                xAxis:
                  description: The xAxis for this bubblePlot.
                  type: string
                yAxis:
                  description: The yAxis for this bubblePlot.
                  type: string
                size:
                  description: The size for this bubblePlot.
                  type: string
                group:
                  description: The group for this bubblePlot.
                  type: string
    dualAxisBarChartRequest:
      description: The dualAxisBarChart details
      type: object
      properties:
        dualAxisBarChart:
          description: The dualAxisBarChart details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this dualAxisBarChart.
                  type: string
                measureBar:
                  description: The measureBar for this dualAxisBarChart.
                  type: string
                measureBar2:
                  description: The measureBar2 for this dualAxisBarChart.
                  type: string
    dotPlotRequest:
      description: The dot plot details
      properties:
        dotPlot:
          description: The dot plot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this dot plot.
                  type: string
                measure:
                  description: The measure for this dot plot.
                  type: string
    targetedBarChart:
      description: The targetedBar Chart details
      type: object
      properties:
        targetedBarChart:
          description: The targetedBar Chart details
          type: object
          properties:
            name:
              description: The name of the targetedBar chart.
              type: string
            label:
              description: The label for the targetedBar chart.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    geoClusterRequest:
      description: The geoCluster details
      type: object
      properties:
        geoCluster:
          description: The geoCluster details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                geography:
                  description: The geography for this geoCluster.
                  type: string
                size:
                  description: The size for this geoCluster.
                  type: string
                color:
                  description: The response for this geoCluster.
                  type: string
    geoPieRequest:
      description: The geoPie details
      type: object
      properties:
        geoPie:
          description: The geoPie details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                geography:
                  description: The geography for this geoPie.
                  type: string
                size:
                  description: The size for this geoPie.
                  type: string
                response:
                  description: The response for this geoPie.
                  type: string
                group:
                  description: The group for this geoPie.
                  type: string
    supportVectorMachine:
      description: The supportVectorMachine details
      type: object
      properties:
        supportVectorMachine:
          description: The supportVectorMachine details
          type: object
          properties:
            response:
              description: The name of the supportVectorMachine.
              type: string
            label:
              description: The label for the supportVectorMachine.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    listTable:
      description: The list table details
      properties:
        listTable:
          description: The list table details
          type: object
          properties:
            name:
              description: The name of the list table.
              type: string
            label:
              description: The label for the list table.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    logisticRegressionRequest:
      description: The logisticRegression details
      type: object
      properties:
        logisticRegression:
          description: The logisticRegression details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                response:
                  description: The response for this logisticRegression.
                  type: string
                continuousEffects:
                  description: The predictors for this logisticRegression.
                  type: array
                  items:
                    type: string
    clusterRequest:
      description: The cluster details
      type: object
      properties:
        cluster:
          description: The cluster details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                variables:
                  description: The variables for this cluster. Minimum two items.
                  type: array
                  items:
                    type: string
    geoContour:
      description: The geoContour details
      type: object
      properties:
        geoContour:
          description: The geoContour details
          type: object
          properties:
            name:
              description: The name of the geoContour.
              type: string
            label:
              description: The label for the geoContour.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    geoRegionCoordinate:
      description: The geoRegionCoordinate details
      type: object
      properties:
        geoRegionCoordinate:
          description: The geoRegionCoordinate details
          type: object
          properties:
            response:
              description: The name of the geoRegionCoordinate.
              type: string
            label:
              description: The label for the geoRegionCoordinate.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    dotPlot:
      description: The dot plot details
      properties:
        dotPlot:
          description: The dot plot details
          type: object
          properties:
            name:
              description: The name of the dot plot.
              type: string
            label:
              description: The label for the dot plot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    linearRegression:
      description: The linear regression details
      properties:
        linearRegression:
          description: The linear regression details
          type: object
          properties:
            name:
              description: The name of the linear regression.
              type: string
            label:
              description: The label for the linear regression.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    supportVectorMachineRequest:
      description: The supportVectorMachine details
      type: object
      properties:
        supportVectorMachine:
          description: The supportVectorMachine details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                response:
                  description: The response for this supportVectorMachine.
                  type: string
                predictors:
                  description: The predictors for this supportVectorMachine.
                  type: array
                  items:
                    type: string
    dualAxisBarLineChart:
      description: The dualAxisBarLineChart details
      type: object
      properties:
        dualAxisBarLineChart:
          description: The dualAxisBarLineChart details
          type: object
          properties:
            response:
              description: The name of the dualAxisBarLineChart.
              type: string
            label:
              description: The label for the dualAxisBarLineChart.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    sliderRequest:
      description: The slider details
      properties:
        slider:
          description: The slider details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                measure:
                  description: The measure for this slider.
                  type: string
    automatedExplanation:
      description: The automated explanation details
      properties:
        automatedExplanation:
          description: The automated explanation details
          type: object
          properties:
            name:
              description: The name of the automated explanation.
              type: string
            label:
              description: The label for the automated explanation.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    scheduleChartRequest:
      description: The scheduleChart details
      type: object
      properties:
        scheduleChart:
          description: The scheduleChart details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                task:
                  description: The task for this stepPlot.
                  type: string
                start:
                  description: The start for this stepPlot.
                  type: string
                finish:
                  description: The finish for this stepPlot.
                  type: string
                group:
                  description: The group for this stepPlot.
                  type: string
    waterfallChart:
      description: The waterfallChart details
      type: object
      properties:
        waterfallChart:
          description: The waterfallChart details
          type: object
          properties:
            name:
              description: The name of the waterfallChart.
              type: string
            label:
              description: The label for the waterfallChart.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    geoRegionRequest:
      description: The geoRegion details
      type: object
      properties:
        geoRegion:
          description: The geoRegion details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                geography:
                  description: The geography for this geoRegion.
                  type: string
                color:
                  description: The color for this geoRegion.
                  type: string
    numericSeriesPlot:
      description: The numericSeriesPlot details
      type: object
      properties:
        numericSeriesPlot:
          description: The numericSeriesPlot details
          type: object
          properties:
            name:
              description: The name of the numericSeriesPlot.
              type: string
            label:
              description: The label for the numericSeriesPlot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    barChart:
      description: The bar chart details
      type: object
      properties:
        barChart:
          description: The bar chart details
          type: object
          properties:
            name:
              description: The name of the bar chart.
              type: string
            label:
              description: The label for the bar chart.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    scatterPlot:
      description: The scatterPlot details
      type: object
      properties:
        scatterPlot:
          description: The scatterPlot details
          type: object
          properties:
            name:
              description: The name of the scatterPlot.
              type: string
            label:
              description: The label for the scatterPlot.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    geoPie:
      description: The geoPie details
      type: object
      properties:
        geoPie:
          description: The geoPie details
          type: object
          properties:
            name:
              description: The name of the geoPie.
              type: string
            label:
              description: The label for the geoPie.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    crosstabRequest:
      description: The crosstab details
      properties:
        crosstab:
          description: The crosstab details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                rows:
                  description: The rows for this crosstab.
                  type: array
                  items:
                    type: string
                columns:
                  description: The columns for this crosstab.
                  type: array
                  items:
                    type: string
                measures:
                  description: The measures for this crosstab.
                  type: array
                  items:
                    type: string
    forcasting:
      description: The forcasting details
      properties:
        forcasting:
          description: The forcasting details
          type: object
          properties:
            name:
              description: The name of the forcasting object.
              type: string
            label:
              description: The label for the forcasting object.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    dualAxisBarChart:
      description: The dualAxisBarChart details
      type: object
      properties:
        dualAxisBarChart:
          description: The dualAxisBarChart details
          type: object
          properties:
            response:
              description: The name of the dualAxisBarChart.
              type: string
            label:
              description: The label for the dualAxisBarChart.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    gauge:
      description: The gauge details
      type: object
      properties:
        gauge:
          description: The gauge details
          type: object
          properties:
            name:
              description: The name of the gauge.
              type: string
            label:
              description: The label for the gauge.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    scatterPlotRequest:
      description: The scatterPlot details
      type: object
      properties:
        scatterPlot:
          description: The scatterPlot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                measures:
                  description: The measures for this scatterPlot.
                  type: array
                  items:
                    type: string
                color:
                  description: The color for this scatterPlot.
                  type: string
    factorizationMachine:
      description: The factorizationMachine details
      type: object
      properties:
        factorizationMachine:
          description: The factorizationMachine details
          type: object
          properties:
            response:
              description: The name of the factorizationMachine.
              type: string
            label:
              description: The label for the factorizationMachine.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    linearRegressionRequest:
      description: The linear regression details
      properties:
        linearRegression:
          description: The linear regression details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                response:
                  description: The response for this linear regression object.
                  type: string
                continuousEffects:
                  description: The continuous effects for this linear regression object.
                  type: array
                  items:
                    type: string
                classificationEffects:
                  description: The classification effects for this linear regression object.
                  type: array
                  items:
                    type: string
    pathAnalysisRequest:
      description: The pathAnalysis details
      type: object
      properties:
        pathAnalysis:
          description: The pathAnalysis details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                event:
                  description: The event for this pathAnalysis.
                  type: string
                sequenceOrder:
                  description: The sequenceOrder for this pathAnalysis.
                  type: string
                transactionId:
                  description: The transactionId for this pathAnalysis.
                  type: string
                weight:
                  description: The weight for this pathAnalysis.
                  type: string
    heatMapRequest:
      description: The heatMap details
      type: object
      properties:
        heatMap:
          description: The heatMap details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                axisItems:
                  description: The axisItems for this heatMap.
                  type: array
                  items:
                    type: string
                color:
                  description: The color for this heatMap.
                  type: string
    waterfallChartRequest:
      description: The waterfallChart details
      type: object
      properties:
        waterfallChart:
          description: The waterfallChart details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                category:
                  description: The category for this waterfallChart.
                  type: string
                response:
                  description: The response for this waterfallChart.
                  type: string
    geoRegion:
      description: The geoRegion details
      type: object
      properties:
        geoRegion:
          description: The geoRegion details
          type: object
          properties:
            response:
              description: The name of the geoRegion.
              type: string
            label:
              description: The label for the geoRegion.
              type: string
            title:
              description: The title text.
              type: string
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              $ref: "#/components/schemas/dataRoles"
    dualAxisTimeSeriesPlotRequest:
      description: The dualAxisTimeSeriesPlot details
      type: object
      properties:
        dualAxisTimeSeriesPlot:
          description: The dualAxisTimeSeriesPlot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                timeAxis:
                  description: The timeAxis for this dualAxisTimeSeriesPlot.
                  type: string
                measureLine:
                  description: The measureLine for this dualAxisTimeSeriesPlot.
                  type: string
                measureLine2:
                  description: The measureLine2 for this dualAxisTimeSeriesPlot.
                  type: string
    bubbleChangePlotRequest:
      description: The bubbleChangePlot details
      type: object
      properties:
        bubbleChangePlot:
          description: The bubbleChangePlot details
          type: object
          properties:
            dataSource:
              description: The name or id of the data source.
              type: string
            dataRoles:
              description: The data roles.
              type: object
              properties:
                xStart:
                  description: The xStart for this bubbleChangePlot.
                  type: string
                xEnd:
                  description: The xEnd for this bubbleChangePlot.
                  type: string
                yStart:
                  description: The yStart for this bubbleChangePlot.
                  type: string
                yEnd:
                  description: The yEnd for this bubbleChangePlot.
                  type: string
                sizeStart:
                  description: The sizeStart for this bubbleChangePlot.
                  type: string
                sizeEnd:
                  description: The sizeEnd for this bubbleChangePlot.
                  type: string
                group:
                  description: The group for this bubbleChangePlot.
                  type: string
    containerPlacement:
      description: The placement in a container.
      type: object
      properties:
        container:
          type: object
          required:
            - target
          properties:
            target:
              description: The name or id of the container.
              type: string
            position:
              description: The position (default value is end)
              type: string
              enum:
                - start
                - end
    measureDataItem:
      description: The measure specific details of a measure data item
      type: object
      properties:
        name:
          description: The name of the data item.
          type: string
        label:
          description: The label for the data item.
          type: string
        measure:
          description: The category specific details.
          type: object
          required:
            - columnName
          properties:
            columnName:
              description: The column name for this data item.
              type: string
            format:
              description: The format for this data item.
              type: string
            aggregation:
              description: The aggregation
              type: string
    categoryDataItem:
      description: The category specific details of a category data item.
      type: object
      properties:
        name:
          description: The name of the data item.
          type: string
        label:
          description: The label for the data item.
          type: string
        category:
          description: The category specific details.
          type: object
          required:
            - columnName
          properties:
            columnName:
              description: The column name for this data item.
              type: string
            format:
              description: The format for this data item.
              type: string
    hierarchyDataItem:
      description: The hierarchy specific details of a hierarchy data item
      type: object
      properties:
        name:
          description: The name of the data item.
          type: string
        label:
          description: The label of the data item.
          type: string
        hierarchy:
          description: The hierarchy specific details.
          type: object
          required:
            - levels
          properties:
            levels:
              description: The levels for this hierarchy.
              type: array
              items:
                type: string
    pagePlacement:
      description: The placement on a page.
      type: object
      properties:
        page:
          type: object
          required:
            - target
          properties:
            target:
              description: The name or id of the page.
              type: string
            context:
              description: The context (default value is body)
              type: string
              enum:
                - header
                - body
            position:
              description: The position (default value is end)
              type: string
              enum:
                - start
                - end
    dataRoles:
      description: The data roles for an object
      type: array
      items:
        description: A data role with associated data items
        type: object
        properties:
          name:
            description: The name of the role
            type: string
          label:
            description: The label for the role
            type: string
          items:
            type: array
            items:
              $ref: "#/components/schemas/dataItem"
    relativeToObjectPlacement:
      description: The placement relative to another object.
      type: object
      properties:
        relativeToObject:
          type: object
          required:
            - target
          properties:
            target:
              description: The name or id of the relative object for placement.
              type: string
            position:
              description: The position (default value is after)
              type: string
              enum:
                - before
                - after
                - left
                - right
                - top
                - bottom
    reportPlacement:
      description: The placement in a report
      type: object
      properties:
        report:
          type: object
          properties:
            context:
              description: The context (default value of newPage)
              type: string
              enum:
                - newPage
                - header
            position:
              description: The position (default value of end)
              type: string
              enum:
                - start
                - end
            pageName:
              description: The name of the new page
              type: string
            pagePosition:
              description: The position of the new page on the report
              type: number
  examples:
    requestAddDataOperation:
      description: >
        Example of a request that includes an addData operation.
      value:
        version: 1
        resultFolder: /folders/folders/@myFolder
        resultReportName: Report123
        resultNameConflict: replace
        operations:
          - addData:
              cas:
                server: cas-shared-default
                library: Public
                table: AIRLINE_ROUTE_NETWORK
    responseApplyDataViewOperationPut:
      description: >
        Example of a PUT response that includes an applyDataView operation.
      value:
        version: 1
        resultReportId: bfcc1a0b-11a3-40e6-8df3-52c3aa8b653d
        resultReportName: Report1002
        resultReportUri: /reports/reports/bfcc1a0b-11a3-40e6-8df3-52c3aa8b653d
        resultFolderUri: /folders/folders/@myFolder
        operations:
          - name: ds32
            label: CARS
            data:
              name: ds32
              label: CARS
              cas:
                server: cas-shared-default
                library: Public
                table: CARS
                locale: en
              items:
                - name: bi33
                  label: car
                  category:
                    columnName: car
                    format: $
                - name: bi34
                  label: color
                  category:
                    columnName: color
                    format: $
                - name: bi35
                  label: dealer
                  category:
                    columnName: dealer
                    format: $
                - name: bi36
                  label: dest
                  category:
                    columnName: dest
                    format: $
                - name: bi37
                  label: dte
                  category:
                    columnName: dte
                    format: Month
                - name: bi38
                  label: returns
                  measure:
                    columnName: returns
                    format: Numeric
                - name: bi39
                  label: sales
                  measure:
                    columnName: sales
                    format: Numeric
                - name: bi40
                  label: type
                  measure:
                    columnName: type
                    format: Numeric
                - name: bi41
                  label: wght
                  measure:
                    columnName: wght
                    format: Numeric
                - name: bi42
                  label: Frequency
                - name: bi43
                  label: Frequency Percent
            status: Success
        status: Success
        links:
          - method: GET
            rel: getReport
            href: /reportOperations/reports/bfcc1a0b-11a3-40e6-8df3-52c3aa8b653d
            uri: /reportOperations/reports/bfcc1a0b-11a3-40e6-8df3-52c3aa8b653d
            type: application/vnd.sas.report.operations.request+json
    completed_export_package_job:
      description: >
        This is an example of 'completed' export package job response.
      value:
        version: 1
        id: 95af5a12-6cc0-4242-b7bf-7d694b817340
        state: completed
        inputReport: /reports/reports/cbf97b0a-457d-4b4f-8913-547e0cdf390c
        resultFolder: /folders/folders/@myFolder
        resultFileName: Status Report Package
        resultMediaType: application/zip
        nameConflict: replace
        creationTimestamp: 2023-02-09T15:01:49.7167763Z
        endTimestamp: 2023-02-09T15:01:54.335317448Z
        links:
          - method: GET
            rel: self
            href: /visualAnalytics/jobs/95af5a12-6cc0-4242-b7bf-7d694b817340
            uri: /visualAnalytics/jobs/95af5a12-6cc0-4242-b7bf-7d694b817340
            type: application/vnd.sas.visual.analytics.report.export.package.job
            responseType: application/vnd.sas.visual.analytics.report.export.package.job
          - method: DELETE
            rel: delete
            href: /visualAnalytics/jobs/95af5a12-6cc0-4242-b7bf-7d694b817340
            uri: /visualAnalytics/jobs/95af5a12-6cc0-4242-b7bf-7d694b817340
          - method: GET
            rel: result
            href: /files/files/8f622e70-b386-49d3-b7d7-285d981b03b6/content
            uri: /files/files/8f622e70-b386-49d3-b7d7-285d981b03b6/content
            type: application/zip
        reportObjects:
          - Key Value - Marketing Pct of Sales 3
          - Dual Axis Bar-Line - Merchandise Hierarchy 3
        timeout: 60
        wait: 30
    completed_export_data_job:
      description: >
        This is an example of 'completed' export data job response.
      value:
        version: 1
        id: 3234082d-841e-489d-a4b8-808a75c270b0
        state: completed
        inputReport: f4dd1ca2-1b82-4c90-bd6a-26bcd07bee39
        resultFolder: /folders/folders/@myFolder
        resultFileName: exportData
        resultMediaType: CSV
        nameConflict: rename
        creationTimestamp: 2022-03-04T20:15:43.400236638Z
        endTimestamp: 2022-03-04T20:15:46.478072423Z
        links:
          - method: GET
            rel: self
            href: /visualAnalytics/jobs/66d70ca3-c7ac-4460-bffb-bbeb4ab7ac35
            uri: /visualAnalytics/jobs/66d70ca3-c7ac-4460-bffb-bbeb4ab7ac35
            type: application/vnd.sas.visual.analytics.report.export.data.job+json
            responseType: application/vnd.sas.visual.analytics.report.export.data.job+json
          - method: DELETE
            rel: delete
            href: /visualAnalytics/jobs/66d70ca3-c7ac-4460-bffb-bbeb4ab7ac35
            uri: /visualAnalytics/jobs/66d70ca3-c7ac-4460-bffb-bbeb4ab7ac35
          - method: GET
            rel: result
            href: /files/files/84c4d7c7-3711-4d78-9a8f-cddae73c6318/content
            uri: /files/files/84c4d7c7-3711-4d78-9a8f-cddae73c6318/content
        format: CSV
        reportObject: Dual Axis Bar-Line - Merchandise Hierarchy 1
        properties:
          RowCount: "5"
    requestChangeDataOperationPut:
      description: >
        Example of a PUT request that includes an changeData operation.
      value:
        version: 1
        resultFolder: /folders/folders/@myFolder
        resultReportName: Report1002
        resultNameConflict: replace
        operations:
          - includeObjectInResponse: true
            changeData:
              originalData:
                cas:
                  server: cas-shared-default
                  library: Public
                  table: CARS
              replacementData:
                cas:
                  server: cas-shared-default
                  library: Public
                  table: CARSSASHELP
              replacementLabel: Updated CARS
              replacementDataItems:
                - replacementColumn: Make
                  originalColumn: car
                  originalName: bi33
              forceReplace: false
    responseChangeDataOperationPut:
      description: >
        Example of a response for a PUT request that includes a changeData operation.
      value:
        version: 1
        resultReportId: 959f46dc-1ac1-4e7f-b84a-c9b983d79c0f
        resultReportName: Report1002
        resultReportUri: /reports/reports/959f46dc-1ac1-4e7f-b84a-c9b983d79c0f
        resultFolderUri: /folders/folders/@myFolder
        operations:
          - name: ds44
            label: CARSSASHELP
            data:
              name: ds44
              label: CARSSASHELP
              cas:
                server: cas-shared-default
                library: Public
                table: CARSSASHELP
                locale: en
              items:
                - name: bi45
                - name: bi46
                - name: bi47
                - name: bi48
                - name: bi49
                - name: bi50
                - name: bi51
                - name: bi52
                - name: bi53
                - name: bi54
                - name: bi55
                - name: bi56
                - name: bi57
                - name: bi58
                - name: bi59
                - name: bi60
                  label: Frequency
                - name: bi61
                  label: Frequency Percent
            status: Success
        status: Success
        links:
          - method: GET
            rel: getReport
            href: /reportOperations/reports/959f46dc-1ac1-4e7f-b84a-c9b983d79c0f
            uri: /reportOperations/reports/959f46dc-1ac1-4e7f-b84a-c9b983d79c0f
            type: application/vnd.sas.report.operations.request+json
    requestAddObjectOperationPut:
      description: >
        Example of a request that includes an addObject operation to add a bar chart to the report.
      value:
        version: 1
        resultFolder: /folders/folders/@myFolder
        resultReportName: NewReport123
        resultNameConflict: replace
        operations:
          - operationId: barChart
            includeObjectInResponse: true
            addObject:
              object:
                barChart:
                  dataSource: AIRLINE_ROUTE_NETWORK
                  dataRoles:
                    category: airport_name
                    measures:
                      - airport_altitude
                      - distance
              placement:
                page:
                  target: Page 1
                  position: start
    requestAddPageOperation:
      description: >
        Example of a request that includes an addPage operation.
      value:
        version: 1
        resultFolder: /folders/folders/@myFolder
        resultReportName: ReportWithNewPage
        resultNameConflict: replace
        operations:
          - addPage:
              pageName: My New Page
              pagePosition: 0
    running_export_pdf_job:
      description: >
        This is an example of 'running' export data job response.
      value:
        version: 1
        id: fc96caab-1dc8-469b-a797-0823d9b19373
        state: running
        inputReport: /reports/reports/cbf97b0a-457d-4b4f-8913-547e0cdf390c
        resultFolder: /folders/folders/@myFolder
        resultFileName: Status Report Package
        resultMediaType: application/pdf
        nameConflict: replace
        creationTimestamp: 2023-02-09T15:09:55.262624022Z
        endTimestamp: 2023-02-09T15:09:56.005042747Z
        links:
          - method: GET
            rel: self
            href: /visualAnalytics/jobs/fc96caab-1dc8-469b-a797-0823d9b19373
            uri: /visualAnalytics/jobs/fc96caab-1dc8-469b-a797-0823d9b19373
            type: application/vnd.sas.visual.analytics.report.export.pdf.job
            responseType: application/vnd.sas.visual.analytics.report.export.pdf.job
          - method: DELETE
            rel: delete
            href: /visualAnalytics/jobs/fc96caab-1dc8-469b-a797-0823d9b19373
            uri: /visualAnalytics/jobs/fc96caab-1dc8-469b-a797-0823d9b19373
        reportObjects:
          - Key Value - Marketing Pct of Sales 3
          - Dual Axis Bar-Line - Merchandise Hierarchy 3
        timeout: 60
        wait: 1
    responseAddDataOperation:
      description: >
        Example of a response that includes an addData operation.
      value:
        version: 1
        resultReportId: 6f05e067-0728-4eac-bf18-8ccef3d6c46e
        resultReportName: Report123
        resultReportUri: /reports/reports/6f05e067-0728-4eac-bf18-8ccef3d6c46e
        resultFolderUri: /folders/folders/@myFolder
        operations:
          - name: ds7
            label: AIRLINE_ROUTE_NETWORK
            data:
              name: ds7
              label: AIRLINE_ROUTE_NETWORK
              cas:
                server: cas-shared-default
                library: Public
                table: AIRLINE_ROUTE_NETWORK
                locale: ar
              items:
                - name: bi8
                  label: Airline 2-letter IATA code
                  category:
                    columnName: airline_iata
                    format: $
                - name: bi9
                  label: Airline 3-letter ICAO code
                  category:
                    columnName: airline_icao
                    format: $
                - name: bi10
                  label: Airline Country
                  category:
                    columnName: airline_country
                    format: $
                - name: bi11
                  label: Airline Name
                  category:
                    columnName: airline_name
                    format: $
                - name: bi12
                  label: Airline Operational
                  category:
                    columnName: airline_active
                    format: $
                - name: bi13
                  label: Airport 3-letter IATA/FAA
                  category:
                    columnName: airport_iata
                    format: $
                - name: bi14
                  label: Airport 4-letter ICAO
                  category:
                    columnName: airport_icao
                    format: $
                - name: bi15
                  label: Airport Altitude (ft)
                  measure:
                    columnName: airport_altitude
                    format: Numeric
                - name: bi16
                  label: Airport City
                  category:
                    columnName: airport_city
                    format: $
                - name: bi17
                  label: Airport DST
                  category:
                    columnName: airport_dst
                    format: $
                - name: bi18
                  label: Airport Name
                  category:
                    columnName: airport_name
                    format: $
                - name: bi19
                  label: Airport Timezone
                  measure:
                    columnName: airport_timezone
                    format: Numeric
                - name: bi20
                  label: Destination Airport Country
                  category:
                    columnName: dest_airport_country
                    format: $
                - name: bi21
                  label: Destination Airport ID
                  measure:
                    columnName: dest_id
                    format: Numeric
                - name: bi22
                  label: Destination Airport Latitude
                  measure:
                    columnName: dest_airport_latitude
                    format: Numeric
                - name: bi23
                  label: Destination Airport Longitude
                  measure:
                    columnName: dest_airport_longitude
                    format: Numeric
                - name: bi24
                  label: Distance (km)
                  measure:
                    columnName: distance
                    format: Numeric
                - name: bi25
                  label: Edge Index
                  measure:
                    columnName: edge_index
                    format: Numeric
                - name: bi26
                  label: Source Airport Country
                  category:
                    columnName: source_airport_country
                    format: $
                - name: bi27
                  label: Source Airport ID
                  measure:
                    columnName: source_id
                    format: Numeric
                - name: bi28
                  label: Source Airport Latitude
                  measure:
                    columnName: source_airport_latitude
                    format: Numeric
                - name: bi29
                  label: Source Airport Longitude
                  measure:
                    columnName: source_airport_longitude
                    format: Numeric
                - name: bi30
                  label: Frequency
                - name: bi31
                  label: Frequency Percent
            status: Success
        status: Success
        links:
          - method: GET
            rel: getReport
            href: /reportOperations/reports/6f05e067-0728-4eac-bf18-8ccef3d6c46e
            uri: /reportOperations/reports/6f05e067-0728-4eac-bf18-8ccef3d6c46e
            type: application/vnd.sas.report.operations.request+json
    failed_export_data_job:
      description: >
        This is an example of 'failed' export data job response.
      value:
        version: 1
        id: 9ce43c8f-cef8-4895-9de0-b498c54144b7
        state: failed
        inputReport: eb897d90-e4fd-4bdf-a764-b61af5c339b8
        resultFolder: /folders/folders/@myFolder
        resultFileName: exportData
        resultMediaType: CSV
        nameConflict: rename
        creationTimestamp: 2022-03-04T21:29:15.327350123Z
        endTimestamp: 2022-03-04T21:29:48.741968262Z
        errors:
          - version: 2
            httpStatusCode: 500
            errorCode: 23110
            message: export data job failed due to timeout reached
        links:
          - method: GET
            rel: self
            href: /visualAnalytics/jobs/9ce43c8f-cef8-4895-9de0-b498c54144b7
            uri: /visualAnalytics/jobs/9ce43c8f-cef8-4895-9de0-b498c54144b7
            type: application/vnd.sas.visual.analytics.report.export.data.job+json
            responseType: application/vnd.sas.visual.analytics.report.export.data.job+json
          - method: DELETE
            rel: delete
            href: /visualAnalytics/jobs/9ce43c8f-cef8-4895-9de0-b498c54144b7
            uri: /visualAnalytics/jobs/9ce43c8f-cef8-4895-9de0-b498c54144b7
        format: CSV
        reportObject: Cost Details
    export_package_request:
      description: >
        This is an example of default export package request
      value:
        resultFolder: /folders/folders/@myFolder
        resultFilename: Status Report Package
        nameConflict: replace
        reportObjects:
          - Key Value - Marketing Pct of Sales 3
          - Dual Axis Bar-Line - Merchandise Hierarchy 3
        timeout: 60
        wait: 30
        version: 1
    export_data_get_tsv:
      description: >
        This is an example of 'Get' csv response
      value: >
        {
         "STATE"	"Catalog"	"CUSTNUM"
         "OR"	"Collectibles"	"20832000"
         "WA"	"Collectibles"	"."
         "WA"	"Collectibles"	"."
         "WA"	"Collectibles"	"."
         "WA"	"Collectibles"	"2524000"
         "OR"	"Gardening"	"."
         "WA"	"Gardening"	"5548000"
         "WA"	"Gardening"	"."
         "WA"	"Gardening"	"."
         "WA"	"Gardening"	"8762000"
         "OR"	"Pets"	"90272000"
         "WA"	"Pets"	"5548000"
         "WA"	"Pets"	"5420000"
         "WA"	"Pets"	"3666000"
         "WA"	"Pets"	"8750000"
         "OR"	"Software"	"34720000"
         "WA"	"Software"	"9709000"
         "WA"	"Software"	"."
         "WA"	"Software"	"1222000"
         "WA"	"Software"	"5048000"
         "OR"	"Sports"	"13888000"
         "WA"	"Sports"	"9709000"
         "WA"	"Sports"	"2710000"
         "WA"	"Sports"	"2444000"
         "WA"	"Sports"	"15108000"
         "OR"	"Toys"	"48608000"
         "WA"	"Toys"	"1387000"
         "WA"	"Toys"	"1355000"
         "WA"	"Toys"	"2444000"
         "WA"	"Toys"	"10036000"
        }
    requestAddObjectOperationPost:
      description: >
        Example of a request that includes an addObject operation to add a bar chart to the report.
      value:
        version: 1
        resultFolder: /folders/folders/@myFolder
        resultReportName: NewReport123
        resultNameConflict: replace
        operations:
          - includeObjectInResponse: false
            addData:
              cas:
                server: cas-shared-default
                library: Public
                table: AIRLINE_ROUTE_NETWORK
          - includeObjectInResponse: true
            addObject:
              object:
                barChart:
                  dataSource: AIRLINE_ROUTE_NETWORK
                  dataRoles:
                    category: airport_name
                    measures:
                      - airport_altitude
                      - distance
              placement:
                page:
                  target: Page 1
                  position: start
    requestChangeDataOperationPost:
      description: >
        Example of a POST request that includes an changeData operation.
      value:
        version: 1
        resultFolder: /folders/folders/@myFolder
        resultReportName: Report_changedData
        resultNameConflict: replace
        operations:
          - addData:
              cas:
                server: cas-shared-default
                library: Public
                table: CARS
          - addData:
              cas:
                server: cas-shared-default
                library: Public
                table: CARSSASHELP
          - includeObjectInResponse: true
            changeData:
              originalData:
                cas:
                  server: cas-shared-default
                  library: Public
                  table: CARS
              replacementData:
                cas:
                  server: cas-shared-default
                  library: Public
                  table: CARSSASHELP
              replacementLabel: Updated CARS
              replacementDataItems:
                - replacementColumn: Make
                  originalColumn: car
                  originalName: bi33
              forceReplace: false
    running_export_image_job:
      description: >
        This is an example of 'running' export data job response.
      value:
        version: 1
        id: c8b77ae1-1e22-4436-b398-726928015e6a
        state: running
        inputReport: /reports/reports/cbf97b0a-457d-4b4f-8913-547e0cdf390c
        resultMediaType: image/svg
        creationTimestamp: 2022-03-14T19:20:47.3154099Z
        endTimestamp: 2022-03-14T19:20:50.7813154Z
        links:
          - method: GET
            rel: self
            href: /visualAnalytics/jobs/c8b77ae1-1e22-4436-b398-726928015e6a
            uri: /visualAnalytics/jobs/c8b77ae1-1e22-4436-b398-726928015e6a
            type: application/vnd.sas.visual.analytics.report.export.image.job
            responseType: application/vnd.sas.visual.analytics.report.export.image.job
          - method: DELETE
            rel: delete
            href: /visualAnalytics/jobs/c8b77ae1-1e22-4436-b398-726928015e6a
            uri: /visualAnalytics/jobs/c8b77ae1-1e22-4436-b398-726928015e6a
        reportObject: Dual Axis Bar-Line - Merchandise Hierarchy 1
        timeout: 60
        wait: 0
    export_pdf_request:
      description: >
        This is an example of default export pdf request
      value:
        resultFolder: /folders/folders/@myFolder
        resultFilename: Status Report Package
        nameConflict: replace
        reportObjects:
          - Key Value - Marketing Pct of Sales 3
          - Dual Axis Bar-Line - Merchandise Hierarchy 3
        options:
          orientation: landscape
          paperSize: letter
          margin: .25in
          includeTableOfContents: false
          showPageNumbers: true
          showEmptyRowsAndColumns: false
          includeAppendix: true
          includeComments: false
          includeDetailsTables: false
          expandClippedContent: false
          includeCoverPage: true
          coverPageText: ""
        timeout: 60
        wait: 30
        version: 1
    reportObjectCollection:
      description: >
        This is an example of 'completed' export pdf job response.
      value:
        version: 2
        start: 0
        limit: 1024
        name: List of Report Objects
        items:
          - name: vi6
            type: Page
            label: Store Banner Dashboard
            position: 0
            version: 2
          - name: vi361
            type: Page
            label: Geographic Effectiveness
            position: 1
            version: 2
          - name: vi2827
            type: Page
            label: Promotion Effectiveness
            position: 2
            version: 2
          - name: ve55
            type: Text
            label: Store Banner Dashboard Text
            position: 0
            version: 2
          - name: ve152
            type: Graph
            label: Dual Axis Bar-Line - Merchandise Hierarchy 3
            position: 0
            version: 2
          - name: ve166
            type: Graph
            label: Dual Axis Bar-Line - Merchandise Hierarchy 1
            position: 0
            version: 2
          - name: ve179
            type: Graph
            label: Dual Axis Bar-Line - Merchandise Hierarchy 2
            position: 0
            version: 2
          - name: ve332
            type: Text
            label: Store Banner Dashboard Information Text
            position: 0
            version: 2
          - name: ve371
            type: Graph
            label: ROI Region Map
            position: 0
            version: 2
          - name: ve473
            type: Text
            label: Text 2
            position: 0
            version: 2
          - name: ve1153
            type: Text
            label: Geographic Effectiveness Information Text
            position: 0
            version: 2
          - name: ve2983
            type: Text
            label: Promotion Effectiveness Text
            position: 0
            version: 2
          - name: ve4995
            type: Text
            label: Promotion Effectiveness Information Text
            position: 0
            version: 2
          - name: ve73
            type: Graph
            label: Key Value - Marketing Pct of Sales 3
            position: 0
            version: 2
          - name: ve6617
            type: VisualContainer
            label: Layout Container 2
            position: 0
            version: 2
          - name: ve6619
            type: VisualContainer
            label: Layout Container 24
            position: 0
            version: 2
          - name: ve6621
            type: VisualContainer
            label: Layout Container 26
            position: 0
            version: 2
          - name: ve6623
            type: VisualContainer
            label: Layout Container 3
            position: 0
            version: 2
          - name: ve141
            type: Graph
            label: Key Value - Marketing Pct of Sales 2
            position: 0
            version: 2
          - name: ve97
            type: Graph
            label: Key Value - Marketing Pct of Sales 1
            position: 0
            version: 2
          - name: ve6637
            type: VisualContainer
            label: Layout Container 5
            position: 0
            version: 2
          - name: ve2851
            type: Graph
            label: Sales vs Base Tree Map
            position: 0
            version: 2
          - name: ve428
            type: Graph
            label: Sales Region
            position: 0
            version: 2
          - name: ve7162
            type: VisualContainer
            label: Layout Container 4
            position: 0
            version: 2
          - name: ve7164
            type: VisualContainer
            label: Layout Container 1
            position: 0
            version: 2
          - name: ve7225
            type: Graph
            label: Gauge 1
            position: 0
            version: 2
          - name: ve7268
            type: Crosstab
            label: Promotion Details
            position: 0
            version: 2
          - name: ve7495
            type: VisualContainer
            label: Layout Container 6
            position: 0
            version: 2
    requestSetParameterValueOperation:
      description: >
        Example of a request that includes a setParameterValue operation.
      value:
        version: 1
        resultFolder: /folders/folders/@myFolder
        resultReportName: Report123
        resultNameConflict: replace
        operations:
          - setParameterValue:
              name: Age Parameter
              value: 20
    authorizationDenied:
      description: >
        authorization denied
      value:
        httpStatusCode: 403
        errorCode: 23071
        message: user does not have permissions to export data (or detailed data, images, or packages)
        details:
          - "path: /visualAnalytics/reports/eb897d90-e4fd-4bdf-a764-b61af5c339b8/*"
          - "correlator: af574d81-9ec3-4558-be45-27ec433e2fa4"
    responseErrorFailedPrecondition:
      description: >
        Example of an error with a failed precondition on the request.
      value:
        version: 1
        httpStatusCode: 412
        message: One of the preconditions in the request header has failed
        remediation: Update the request header values for the preconditions
    completed_export_image_job:
      description: >
        This is an example of 'completed' export image job response.
      value:
        version: 1
        id: 35be55e4-75ce-4ece-8d74-ed786273e035
        state: completed
        inputReport: /reports/reports/cbf97b0a-457d-4b4f-8913-547e0cdf390c
        resultMediaType: image/svg
        creationTimestamp: 2022-03-14T19:23:40.1684707Z
        endTimestamp: 2022-03-14T19:23:46.1390352Z
        links:
          - method: GET
            rel: self
            href: /visualAnalytics/jobs/35be55e4-75ce-4ece-8d74-ed786273e035
            uri: /visualAnalytics/jobs/35be55e4-75ce-4ece-8d74-ed786273e035
            type: application/vnd.sas.visual.analytics.report.export.image.job
            responseType: application/vnd.sas.visual.analytics.report.export.image.job
          - method: DELETE
            rel: delete
            href: /visualAnalytics/jobs/35be55e4-75ce-4ece-8d74-ed786273e035
            uri: /visualAnalytics/jobs/35be55e4-75ce-4ece-8d74-ed786273e035
          - method: GET
            rel: result
            href: /reportImages/images/K1234885385B1757751810.svg
            uri: /reportImages/images/K1234885385B1757751810.svg
            type: image/svg+xml
        reportObject: Dual Axis Bar-Line - Merchandise Hierarchy 1
        timeout: 60
        wait: 30
    export_error404:
      description: >
        This is an example of  export data job request
      value:
        version: 2
        httpStatusCode: 404
        errorCode: 23005
        message: No report object was found having the label Dual Axis Bar Line - Merchandise Hierarchy 3
        details:
          - "path: /visualAnalytics/reports/cbf97b0a-457d-4b4f-8913-547e0cdf390c/exportPackage"
          - "correlator: fce9d76e-0859-4f80-97ee-307619383c10"
    responseErrorFileAlreadyExists:
      description: >
        Example of an error for a request where the file specified to save the report already exists.
      value:
        version: 1
        httpStatusCode: 409
        message: "File with this name already exists: Report123"
        remediation: Specify a unique name for the report or use the resultNameConflict property as appropriate for report name conflict resolution
    requestApplyDataViewOperationPost:
      description: >
        Example of a POST request that includes an applyDataView operation.
      value:
        version: 1
        resultFolder: /folders/folders/@myFolder
        resultReportName: ReportApplyDataView
        resultNameConflict: replace
        operations:
          - addData:
              cas:
                server: cas-shared-default
                library: Public
                table: CARS
          - includeObjectInResponse: true
            applyDataView:
              dataItemConflictResolution: createDuplicate
              dataView:
                name: CARS_View_1
              targetData:
                cas:
                  server: cas-shared-default
                  library: Public
                  table: CARS
    responseApplyDataViewOperationPost:
      description: >
        Example of a POST response that includes an applyDataView operation.
      value:
        version: 1
        resultReportId: be7d0686-f51d-4ead-bd99-67552e93e131
        resultReportName: ReportApplyDataView
        resultReportUri: /reports/reports/be7d0686-f51d-4ead-bd99-67552e93e131
        resultFolderUri: /folders/folders/@myFolder
        operations:
          - name: ds7
            label: CARS
            status: Success
          - name: ds7
            label: CARS
            data:
              name: ds7
              label: CARS
              cas:
                server: cas-shared-default
                library: Public
                table: CARS
                locale: en
              items:
                - name: bi8
                  label: car
                  category:
                    columnName: car
                    format: $
                - name: bi9
                  label: color
                  category:
                    columnName: color
                    format: $
                - name: bi10
                  label: dealer
                  category:
                    columnName: dealer
                    format: $
                - name: bi11
                  label: dest
                  category:
                    columnName: dest
                    format: $
                - name: bi12
                  label: dte
                  category:
                    columnName: dte
                    format: Month
                - name: bi13
                  label: returns
                  measure:
                    columnName: returns
                    format: Numeric
                - name: bi14
                  label: sales
                  measure:
                    columnName: sales
                    format: Numeric
                - name: bi15
                  label: type
                  measure:
                    columnName: type
                    format: Numeric
                - name: bi16
                  label: wght
                  measure:
                    columnName: wght
                    format: Numeric
                - name: bi17
                  label: Frequency
                - name: bi18
                  label: Frequency Percent
            status: Success
        status: Success
        links:
          - method: GET
            rel: getReport
            href: /reportOperations/reports/be7d0686-f51d-4ead-bd99-67552e93e131
            uri: /reportOperations/reports/be7d0686-f51d-4ead-bd99-67552e93e131
            type: application/vnd.sas.report.operations.request+json
    responseAddPageOperation:
      description: >
        Example of a response that includes an addPage operation.
      value:
        id: operation123
        version: 1
        resultReportId: 3122a48c-e7d3-4922-9ed4-46e9d61a83e4
        resultReportName: ReportWithNewPage
        resultReportUri: /reports/reports/3122a48c-e7d3-4922-9ed4-46e9d61a83e4
        resultFolderUri: /folders/folders/@myFolder
        operations:
          - name: vi70
            label: My New Page
            status: Success
        status: Success
        links:
          - method: GET
            rel: getReport
            href: /reportOperations/reports/3122a48c-e7d3-4922-9ed4-46e9d61a83e4
            uri: /reportOperations/reports/3122a48c-e7d3-4922-9ed4-46e9d61a83e4
            type: application/vnd.sas.report.operations.request+json
    responseAddObjectOperationPost:
      description: >
        Example of a request that includes an addObject operation to add a bar chart to the report.
      value:
        version: 1
        resultReportId: 0ac9d81c-d990-4186-b8bc-51db2b750dc5
        resultReportName: NewReport123
        resultReportUri: /reports/reports/0ac9d81c-d990-4186-b8bc-51db2b750dc5
        resultFolderUri: /folders/folders/@myFolder
        operations:
          - name: ds7
            label: AIRLINE_ROUTE_NETWORK
            status: Success
          - name: ve33
            label: Bar 1
            object:
              barChart:
                name: ve33
                label: Bar 1
                dataSource: AIRLINE_ROUTE_NETWORK
                dataRoles:
                  - name: CATEGORY
                    label: Category
                    items:
                      - name: bi18
                        label: Airport Name
                        category:
                          columnName: airport_name
                          format: $
                  - name: RESPONSE
                    label: Measure
                    items:
                      - name: bi30
                        label: Frequency
                      - name: bi15
                        label: Airport Altitude (ft)
                        measure:
                          columnName: airport_altitude
                          format: Numeric
                      - name: bi24
                        label: Distance (km)
                        measure:
                          columnName: distance
                          format: Numeric
                  - name: TIP
                    label: Data tip values
                    items:
                      - name: bi18
                        label: Airport Name
                        category:
                          columnName: airport_name
                          format: $
                      - name: bi30
                        label: Frequency
                      - name: bi15
                        label: Airport Altitude (ft)
                        measure:
                          columnName: airport_altitude
                          format: Numeric
                      - name: bi24
                        label: Distance (km)
                        measure:
                          columnName: distance
                          format: Numeric
            layout:
              extendWidthIfAvailable: true
              shrinkWidthIfNecessary: true
              extendHeightIfAvailable: true
              shrinkHeightIfNecessary: true
            status: Success
        status: Success
        links:
          - method: GET
            rel: getReport
            href: /reportOperations/reports/0ac9d81c-d990-4186-b8bc-51db2b750dc5
            uri: /reportOperations/reports/0ac9d81c-d990-4186-b8bc-51db2b750dc5
            type: application/vnd.sas.report.operations.request+json
    responseErrorReportNotFound:
      description: >
        Example of an error for a request where the folder to save the report was not found.
      value:
        version: 1
        httpStatusCode: 404
        message: Unable to load the report 7e40bb49-148f-45b1-b269-f336a30ca39f
        remediation: Specify a valid report as the source for this request
    completed_export_pdf_job:
      description: >
        This is an example of 'completed' export pdf job response.
      value:
        version: 1
        id: 02fa2114-c111-420e-ac55-76ffed871412
        state: completed
        inputReport: /reports/reports/cbf97b0a-457d-4b4f-8913-547e0cdf390c
        resultFolder: /folders/folders/@myFolder
        resultFileName: Status Report Package
        resultMediaType: application/pdf
        nameConflict: replace
        creationTimestamp: 2023-02-09T15:05:52.119072Z
        endTimestamp: 2023-02-09T15:05:57.440367Z
        links:
          - method: GET
            rel: self
            href: /visualAnalytics/jobs/02fa2114-c111-420e-ac55-76ffed871412
            uri: /visualAnalytics/jobs/02fa2114-c111-420e-ac55-76ffed871412
            type: application/vnd.sas.visual.analytics.report.export.pdf.job
            responseType: application/vnd.sas.visual.analytics.report.export.pdf.job
          - method: DELETE
            rel: delete
            href: /visualAnalytics/jobs/02fa2114-c111-420e-ac55-76ffed871412
            uri: /visualAnalytics/jobs/02fa2114-c111-420e-ac55-76ffed871412
          - method: GET
            rel: result
            href: /files/files/006b1434-1c24-4713-950a-7fddffbcebf3/content
            uri: /files/files/006b1434-1c24-4713-950a-7fddffbcebf3/content
            type: application/pdf
        reportObjects:
          - Key Value - Marketing Pct of Sales 3
          - Dual Axis Bar-Line - Merchandise Hierarchy 3
        timeout: 60
        wait: 30
    export_data_default_request:
      description: >
        This is an example of default export data request
      value:
        format: csv
        reportObject: Cost Details
        resultFolder: /folders/folders/@myFolder
        resultFilename: exportData
        nameConflict: rename
        wait: 15
        options:
          startRow: 0
          endRow: -1
          columns: []
          formattedData: true
          detailedData: false
        version: 1
    running_export_package_job:
      description: >
        This is an example of 'running' export data job response.
      value:
        version: 1
        id: 4c6989e6-0f01-413b-a463-72df3a3ac5b1
        state: running
        inputReport: /reports/reports/cbf97b0a-457d-4b4f-8913-547e0cdf390c
        resultFolder: /folders/folders/@myFolder
        resultFileName: Status Report Package
        resultMediaType: application/zip
        nameConflict: replace
        creationTimestamp: 2023-02-09T15:13:47.538140913Z
        endTimestamp: 2023-02-09T15:13:48.3107396Z
        links:
          - method: GET
            rel: self
            href: /visualAnalytics/jobs/4c6989e6-0f01-413b-a463-72df3a3ac5b1
            uri: /visualAnalytics/jobs/4c6989e6-0f01-413b-a463-72df3a3ac5b1
            type: application/vnd.sas.visual.analytics.report.export.package.job
            responseType: application/vnd.sas.visual.analytics.report.export.package.job
          - method: DELETE
            rel: delete
            href: /visualAnalytics/jobs/4c6989e6-0f01-413b-a463-72df3a3ac5b1
            uri: /visualAnalytics/jobs/4c6989e6-0f01-413b-a463-72df3a3ac5b1
        reportObjects:
          - Key Value - Marketing Pct of Sales 3
          - Dual Axis Bar-Line - Merchandise Hierarchy 3
        timeout: 60
        wait: 1
    export_data_get_csv:
      description: >
        This is an example of 'Get' csv response
      value: >
        {
          "STATE","CITY","Catalog","CUSTNUM"
          "OR","","Collectibles","20832000"
          "WA","Olympia","Collectibles","."
          "WA","Redmond","Collectibles","."
          "WA","Renton","Collectibles","."
          "WA","Seattle","Collectibles","2524000"
          "OR","","Gardening","."
          "WA","Olympia","Gardening","5548000"
          "WA","Redmond","Gardening","."
          "WA","Renton","Gardening","."
          "WA","Seattle","Gardening","8762000"
          "OR","","Pets","90272000"
          "WA","Olympia","Pets","5548000"
          "WA","Redmond","Pets","5420000"
          "WA","Renton","Pets","3666000"
          "WA","Seattle","Pets","8750000"
          "OR","","Software","34720000"
          "WA","Olympia","Software","9709000"
          "WA","Redmond","Software","."
          "WA","Renton","Software","1222000"
          "WA","Seattle","Software","5048000"
          "OR","","Sports","13888000"
          "WA","Olympia","Sports","9709000"
          "WA","Redmond","Sports","2710000"
          "WA","Renton","Sports","2444000"
          "WA","Seattle","Sports","15108000"
          "OR","","Toys","48608000"
        }
    export_image_default_request:
      description: >
        This is an example of default export image request
      value:
        resultFolder: /folders/folders/@myFolder
        resultFilename: Sample Output File Name.svg
        nameConflict: replace
        reportObject: Dual Axis Bar-Line - Merchandise Hierarchy 1
        image:
          format: svg
          size: 2000px, 1600px
        timeout: 60
        wait: 30
        version: 1
    Notfound_failed_export_data_job:
      description: >
        This is an example of 'failed' export data job response with status code Bad request for invalid report id
      value:
        id: abca11123
        version: 2
        httpStatusCode: 400
        message: Bad Request
        details:
          - The specified report was not found.
    get_export_data_400error:
      description: >
        This is an example of Bad request GET export data call
      value:
        version: 2
        httpStatusCode: 400
        errorCode: 23005
        message: "Unable to resolve reportObject: "
        details:
          - "path: /visualAnalytics/reports/0b6d7dc3-8a33-4ce0-b090-4375b5146146/csv"
          - "correlator: 9094b47d-3afe-4e01-b15e-b21536b3b96a"
    running_export_data_job:
      description: >
        This is an example of 'running' export data job response.
      value:
        version: 1
        id: 99bbf4f9-c444-4ad0-a34c-8a8cf4c576bc
        state: running
        inputReport: eb897d90-e4fd-4bdf-a764-b61af5c339b8
        resultFolder: /folders/folders/@myFolder
        resultFileName: exportData
        resultMediaType: CSV
        nameConflict: rename
        creationTimestamp: 2022-03-04T21:44:13.600420434Z
        endTimestamp: 2022-03-04T21:44:44.011066041Z
        links:
          - method: GET
            rel: self
            href: /visualAnalytics/jobs/99bbf4f9-c444-4ad0-a34c-8a8cf4c576bc
            uri: /visualAnalytics/jobs/99bbf4f9-c444-4ad0-a34c-8a8cf4c576bc
            type: application/vnd.sas.visual.analytics.report.export.data.job+json
            responseType: application/vnd.sas.visual.analytics.report.export.data.job+json
          - method: DELETE
            rel: delete
            href: /visualAnalytics/jobs/99bbf4f9-c444-4ad0-a34c-8a8cf4c576bc
            uri: /visualAnalytics/jobs/99bbf4f9-c444-4ad0-a34c-8a8cf4c576bc
        format: CSV
        reportObject: Cost Details
    root:
      description: >
        This is an example of root endpoint response.
      value:
        version: 5
        links:
          - method: GET
            rel: reportPdf
            href: /visualAnalytics/reports/{reportId}/pdf
            uri: /visualAnalytics/reports/{reportId}/pdf
            responseType: application/pdf
          - method: GET
            rel: reportImage
            href: /visualAnalytics/reports/{reportId}/svg
            uri: /visualAnalytics/reports/{reportId}/svg
            responseType: image/svg+xml
          - method: GET
            rel: reportImage
            href: /visualAnalytics/reports/{reportId}/png
            uri: /visualAnalytics/reports/{reportId}/png
            responseType: image/png
          - method: GET
            rel: reportPackage
            href: /visualAnalytics/reports/{reportId}/package
            uri: /visualAnalytics/reports/{reportId}/package
            responseType: application/zip
          - method: GET
            rel: reportDataCSV
            href: /visualAnalytics/reports/{reportId}/csv
            uri: /visualAnalytics/reports/{reportId}/csv
            responseType: text/csv;cahrset=UTF-8
          - method: GET
            rel: reportDataTSV
            href: /visualAnalytics/reports/{reportId}/tsv
            uri: /visualAnalytics/reports/{reportId}/tsv
            responseType: text/tsv
          - method: GET
            rel: reportDataXLSX
            href: /visualAnalytics/reports/{reportId}/xlsx
            uri: /visualAnalytics/reports/{reportId}/xlsx
            responseType: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
          - method: POST
            rel: runReportPdf
            href: /visualAnalytics/reports/{reportId}/exportPdf
            uri: /visualAnalytics/reports/{reportId}/exportPdf
            type: application/vnd.sas.visual.analytics.report.export.pdf.request
            responseType: application/vnd.sas.visual.analytics.report.export.pdf.job
          - method: POST
            rel: runReportPackage
            href: /visualAnalytics/reports/{reportId}/exportPackage
            uri: /visualAnalytics/reports/{reportId}/exportPackage
            type: application/vnd.sas.visual.analytics.report.export.package.request
            responseType: application/vnd.sas.visual.analytics.report.export.package.job
          - method: POST
            rel: runReportImage
            href: /visualAnalytics/reports/{reportId}/exportImage
            uri: /visualAnalytics/reports/{reportId}/exportImage
            type: application/vnd.sas.visual.analytics.report.export.image.request
            responseType: application/vnd.sas.visual.analytics.report.export.image.job
          - method: POST
            rel: runReportData
            href: /visualAnalytics/reports/{reportId}/exportData
            uri: /visualAnalytics/reports/{reportId}/exportData
            type: application/vnd.sas.visual.analytics.report.export.data.request
            responseType: application/vnd.sas.visual.analytics.report.export.data.job
    responseSetParameterValueOperation:
      description: >
        Example of a response that includes a setParameterValue operation.
      value:
        version: 1
        resultReportId: d0af6ece-6e60-4294-837d-5487a4aedb66
        resultReportName: Report123
        resultReportUri: /reports/reports/d0af6ece-6e60-4294-837d-5487a4aedb66
        resultFolderUri: /folders/folders/@myFolder
        operations:
          - name: pr76
            value: 20
            parameter:
              name: pr76
              label: Age Parameter
              format: COMMA12.2
              value: 20
            status: Success
        status: Success
        links:
          - method: GET
            rel: getReport
            href: /reportOperations/reports/d0af6ece-6e60-4294-837d-5487a4aedb66
            uri: /reportOperations/reports/d0af6ece-6e60-4294-837d-5487a4aedb66
            type: application/vnd.sas.report.operations.request+json
    responseChangeDataOperationPost:
      description: >
        Example of a response for a POST request that includes a changeData operation.
      value:
        version: 1
        resultReportId: 236e8ddd-74e2-49b1-b970-7c175ac8b5f1
        resultReportName: Report_changedData
        resultReportUri: /reports/reports/236e8ddd-74e2-49b1-b970-7c175ac8b5f1
        resultFolderUri: /folders/folders/@myFolder
        operations:
          - name: ds7
            label: CARS
            status: Success
          - name: ds19
            label: CARSSASHELP
            status: Success
          - name: ds19
            label: CARSSASHELP
            data:
              name: ds19
              label: CARSSASHELP
              cas:
                server: cas-shared-default
                library: Public
                table: CARSSASHELP
                locale: en
              items:
                - name: bi20
                - name: bi21
                - name: bi22
                - name: bi23
                - name: bi24
                - name: bi25
                - name: bi26
                - name: bi27
                - name: bi28
                - name: bi29
                - name: bi30
                - name: bi31
                - name: bi32
                - name: bi33
                - name: bi34
                - name: bi35
                  label: Frequency
                - name: bi36
                  label: Frequency Percent
            status: Success
        status: Success
        links:
          - method: GET
            rel: getReport
            href: /reportOperations/reports/236e8ddd-74e2-49b1-b970-7c175ac8b5f1
            uri: /reportOperations/reports/236e8ddd-74e2-49b1-b970-7c175ac8b5f1
            type: application/vnd.sas.report.operations.request+json
    responseAddDataOperationFailure:
      description: >
        Example of a request that includes an addData operation that was unable to find the data.
      value:
        version: 1
        operations:
          - status: Failed
            messages:
              - Unable to add the data to the report
        status: Failed
        messages:
          - Operation addData failed at index 0
          - The report changes were not saved
    responseErrorNoPrecondition:
      description: >
        Example of an error on the request with no precondition specified.
      value:
        version: 1
        httpStatusCode: 428
        message: Neither an if-match etag nor an if-unmodified-since timestamp were provided in the request header
        remediation: Provide either the report etag as the if-match value or a timestamp as the if-unmodified-since value in the request header
    export_package_job200:
      description: This is an example of success export package jobId call
      value:
        id: 12345678-1234-1234-1234-123456789abc
        state: running
        inputReport: /reports/reports/12345678-abcd-ef12-3456-12345678abcd
        reportObjects:
          - Bar Graph 1
          - Table of Frequencies
        resultFolder: /folders/folders/01234567-0123-0123-0123-0123456789ab
        resultFileName: Status Report Package
        nameConflict: replace
        resultMediaType: application/zip
        creationTimeStamp: 2021-06-21T21:10:31.123Z
        endTimeStamp: 2021-06-21T21:10:41.123Z
        links:
          - rel: self
            method: GET
            type: application/vnd.sas.visual.analytics.report.export.package.job
            uri: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
            href: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
          - rel: result
            method: GET
            type: application/*
            uri: /files/files/12345678-1234-1234-1234-123456789abc/content
            href: /files/files/12345678-1234-1234-1234-123456789abc/content
          - rel: delete
            method: DELETE
            uri: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
            href: /visualAnalytics/jobs/12345678-1234-1234-1234-123456789abc
          - rel: deleteContent
            method: DELETE
            uri: /files/files/12345678-1234-1234-1234-123456789abc
            href: /files/files/12345678-1234-1234-1234-123456789abc
        version: 1
    requestApplyDataViewOperationPut:
      description: >
        Example of a PUT request that includes an applyDataView operation.
      value:
        version: 1
        resultFolder: /folders/folders/@myFolder
        resultReportName: Report1002
        resultNameConflict: replace
        operations:
          - includeObjectInResponse: true
            applyDataView:
              dataItemConflictResolution: createDuplicate
              dataView:
                name: CARS_View_1
              targetData:
                cas:
                  server: cas-shared-default
                  library: Public
                  table: CARS
    responseAddObjectOperationPut:
      description: >
        Example of a request that includes an addObject operation to add a bar chart to the report.
      value:
        version: 1
        resultReportId: 0ac9d81c-d990-4186-b8bc-51db2b750dc5
        resultReportName: NewReport123
        resultReportUri: /reports/reports/0ac9d81c-d990-4186-b8bc-51db2b750dc5
        resultFolderUri: /folders/folders/@myFolder
        operations:
          - name: ve71
            label: Bar 1
            object:
              barChart:
                name: ve71
                label: Bar 1
                dataSource: AIRLINE_ROUTE_NETWORK
                dataRoles:
                  - name: CATEGORY
                    label: Category
                    items:
                      - name: bi18
                        label: Airport Name
                        category:
                          columnName: airport_name
                          format: $
                  - name: RESPONSE
                    label: Measure
                    items:
                      - name: bi30
                        label: Frequency
                      - name: bi15
                        label: Airport Altitude (ft)
                        measure:
                          columnName: airport_altitude
                          format: Numeric
                      - name: bi24
                        label: Distance (km)
                        measure:
                          columnName: distance
                          format: Numeric
                  - name: TIP
                    label: Data tip values
                    items:
                      - name: bi18
                        label: Airport Name
                        category:
                          columnName: airport_name
                          format: $
                      - name: bi30
                        label: Frequency
                      - name: bi15
                        label: Airport Altitude (ft)
                        measure:
                          columnName: airport_altitude
                          format: Numeric
                      - name: bi24
                        label: Distance (km)
                        measure:
                          columnName: distance
                          format: Numeric
            layout:
              extendWidthIfAvailable: true
              shrinkWidthIfNecessary: true
              extendHeightIfAvailable: true
              shrinkHeightIfNecessary: true
            status: Success
        status: Success
        links:
          - method: GET
            rel: getReport
            href: /reportOperations/reports/0ac9d81c-d990-4186-b8bc-51db2b750dc5
            uri: /reportOperations/reports/0ac9d81c-d990-4186-b8bc-51db2b750dc5
            type: application/vnd.sas.report.operations.request+json
    error2:
      description: >
        This is an example of Bad request GET export data call
      value:
        version: 2
        httpStatusCode: 400
        errorCode: 23005
        message: "Unable to resolve reportObject: "
        details:
          - "path: /visualAnalytics/reports/0b6d7dc3-8a33-4ce0-b090-4375b5146146/csv"
          - "correlator: 9094b47d-3afe-4e01-b15e-b21536b3b96a"
