openapi: 3.1.0
info:
  title: Zoho Analytics Bulk Bulk Export - Asynchronous Modeling APIs API
  version: v2
  description: API for Zoho Analytics Bulk Operations, including data import and export.
servers:
- url: https://analyticsapi.zoho.com
security:
- iam-oauth2-schema:
  - ZohoAnalytics.data.read
  - ZohoAnalytics.data.create
  - ZohoAnalytics.data.update
  - ZohoAnalytics.data.delete
  - ZohoAnalytics.data.all
tags:
- name: Modeling APIs
  description: Modeling APIs manage workspaces, views, columns, and folders, and support copying across or within Zoho Analytics accounts.
paths:
  /restapi/v2/workspaces:
    post:
      tags:
      - Modeling APIs
      summary: Create Workspace
      description: Create a blank workspace in the specified organization.
      operationId: createWorkspace
      parameters:
      - name: ZANALYTICS-ORGID
        in: header
        required: true
        schema:
          type: string
        description: Organization ID (source org).
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/CreateWorkspaceConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      responses:
        '200':
          description: Workspace created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspaceResponse'
              examples:
                success:
                  value:
                    status: success
                    summary: Create workspace
                    data:
                      workspaceId: '1767024000003145002'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}:
    post:
      tags:
      - Modeling APIs
      summary: Copy Workspace
      description: Copy the specified workspace to another org or within the same org.
      operationId: copyWorkspace
      parameters:
      - name: ZANALYTICS-ORGID
        in: header
        required: true
        schema:
          type: string
        description: Source Organization ID
      - name: ZANALYTICS-DEST-ORGID
        in: header
        required: false
        schema:
          type: string
        description: Destination Organization ID
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
        description: Workspace ID to be copied
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/CopyWorkspaceConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      responses:
        '200':
          description: Workspace copied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CopyWorkspaceResponse'
              examples:
                success:
                  value:
                    status: success
                    summary: Copy workspace
                    data:
                      workspaceId: '1767024000003145006'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    put:
      tags:
      - Modeling APIs
      summary: Rename Workspace
      description: Renames the specified workspace.
      operationId: renameWorkspace
      parameters:
      - name: ZANALYTICS-ORGID
        in: header
        required: true
        schema:
          type: string
        description: Organization ID
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
        description: ID of the workspace to rename
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/RenameWorkspaceConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      responses:
        '204':
          description: Workspace renamed successfully (No Content)
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    delete:
      tags:
      - Modeling APIs
      summary: Delete Workspace
      description: Deletes the specified workspace.
      operationId: deleteWorkspace
      parameters:
      - name: ZANALYTICS-ORGID
        in: header
        required: true
        schema:
          type: string
        description: Organization ID
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
        description: ID of the workspace to delete
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
      responses:
        '204':
          description: Workspace deleted successfully (No Content)
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/tables:
    post:
      tags:
      - Modeling APIs
      summary: Create Table
      description: Create a table in the specified workspace.
      operationId: createTable
      parameters:
      - name: ZANALYTICS-ORGID
        in: header
        required: true
        schema:
          type: string
        description: Organization ID
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
        description: Workspace ID
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/CreateTableConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      responses:
        '200':
          description: Table created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTableResponse'
              examples:
                success:
                  value:
                    status: success
                    summary: Create table
                    data:
                      viewId: '1767024000003145012'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/querytables:
    post:
      tags:
      - Modeling APIs
      summary: Create Query Table
      description: This API allows you to create a query table using a SQL SELECT query.
      operationId: createQueryTable
      parameters:
      - name: ZANALYTICS-ORGID
        in: header
        required: true
        schema:
          type: string
        description: Organization ID
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
        description: Workspace ID
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/CreateQueryTableConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      responses:
        '200':
          description: Query table created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateQueryTableResponse'
              examples:
                success:
                  value:
                    status: success
                    summary: Create query table
                    data:
                      viewId: '1767024000003145013'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/querytables/{table-id}:
    put:
      tags:
      - Modeling APIs
      summary: Edit Query Table
      description: This API allows you to update an existing query table using a SQL SELECT query.
      operationId: editQueryTable
      parameters:
      - name: ZANALYTICS-ORGID
        in: header
        required: true
        schema:
          type: string
        description: Organization ID
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
        description: Workspace ID
      - name: table-id
        in: path
        required: true
        schema:
          type: string
        description: Query Table ID
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/EditQueryTableConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      responses:
        '204':
          description: Query table updated successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/reports:
    post:
      tags:
      - Modeling APIs
      summary: Create Report
      description: This API allows you to create a report (chart/table/pivot) in a workspace.
      operationId: createReport
      parameters:
      - name: ZANALYTICS-ORGID
        in: header
        required: true
        schema:
          type: string
        description: Organization ID
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
        description: Workspace ID
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/CreateReportConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      responses:
        '200':
          description: Report created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateReportResponse'
              examples:
                success:
                  value:
                    status: success
                    summary: Create report
                    data:
                      reportId: '1767024000003145020'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/reports/{report-id}:
    put:
      tags:
      - Modeling APIs
      summary: Update Report
      description: This API allows you to update the metadata or design of an existing report.
      operationId: updateReport
      parameters:
      - name: ZANALYTICS-ORGID
        in: header
        required: true
        schema:
          type: string
        description: Organization ID
      - name: workspace-id
        in: path
        required: true
        schema:
          type: string
        description: Workspace ID
      - name: report-id
        in: path
        required: true
        schema:
          type: string
        description: Report ID
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/UpdateReportConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      responses:
        '204':
          description: Report updated successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/saveas:
    post:
      tags:
      - Modeling APIs
      summary: Save As View
      description: This API creates a new view by duplicating an existing one.
      operationId: saveAsView
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/SaveAsViewConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      responses:
        '200':
          description: New view created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SaveAsViewResponse'
              examples:
                success:
                  value:
                    status: success
                    summary: Saveas view
                    data:
                      viewId: '1767024000004723001'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/movetofolder:
    put:
      tags:
      - Modeling APIs
      summary: Move Views To Folder
      description: Moves multiple views into a specified folder.
      operationId: moveViewsToFolder
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/MoveViewsToFolderConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      responses:
        '204':
          description: Views moved successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}:
    put:
      tags:
      - Modeling APIs
      summary: Rename View
      description: Renames an existing view.
      operationId: renameView
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/RenameViewConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      responses:
        '204':
          description: View renamed successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    delete:
      tags:
      - Modeling APIs
      summary: Delete View
      description: Moves the view to trash.
      operationId: deleteView
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: false
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/DeleteViewConfig'
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
      responses:
        '204':
          description: View deleted and moved to trash.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/trash/{view-id}:
    post:
      tags:
      - Modeling APIs
      summary: Restore Trash View
      description: Restores a view from trash.
      operationId: restoreTrashView
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: false
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/RestoreTrashViewConfig'
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      responses:
        '204':
          description: Trash view restored successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    delete:
      tags:
      - Modeling APIs
      summary: Delete Trash View
      description: Permanently deletes a view from trash.
      operationId: deleteTrashView
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: false
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/DeleteTrashViewConfig'
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
      responses:
        '204':
          description: View deleted permanently from trash.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/folders:
    post:
      tags:
      - Modeling APIs
      summary: Create Folder
      description: Create a folder under a specified workspace to organize views.
      operationId: createFolder
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/CreateFolderConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '200':
          description: Folder created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFolderResponse'
              examples:
                success:
                  value:
                    status: success
                    summary: Create folder
                    data:
                      folderId: '1767024000004578011'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
  /restapi/v2/workspaces/{workspace-id}/folders/{folder-id}:
    put:
      tags:
      - Modeling APIs
      summary: Rename Folder
      description: Rename an existing folder in the workspace.
      operationId: renameFolder
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/folder-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/RenameFolderConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '204':
          description: Folder renamed successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
    delete:
      tags:
      - Modeling APIs
      summary: Delete Folder
      description: Delete a folder from the workspace. Optionally delete views within.
      operationId: deleteFolder
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/folder-id'
      requestBody:
        required: false
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/DeleteFolderConfig'
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '204':
          description: Folder deleted successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
  /restapi/v2/workspaces/{workspace-id}/folders/{folder-id}/default:
    post:
      tags:
      - Modeling APIs
      summary: Make Default Folder
      description: Set the specified folder as the default folder for a given view type.
      operationId: makeDefaultFolder
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/folder-id'
      responses:
        '204':
          description: Default folder set successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
  /restapi/v2/workspaces/{workspace-id}/folders/{folder-id}/move:
    put:
      tags:
      - Modeling APIs
      summary: Change Folder Hierarchy
      description: Update the hierarchy of a folder (parent or child) and set its parent if needed.
      operationId: changeFolderHierarchy
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/folder-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/ChangeFolderHierarchyConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '204':
          description: Folder hierarchy updated successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
  /restapi/v2/workspaces/{workspace-id}/folders/{folder-id}/reorder:
    put:
      tags:
      - Modeling APIs
      summary: Change Folder Position
      description: Reorder a folder by moving it relative to another folder.
      operationId: changeFolderPosition
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/folder-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/ChangeFolderPositionConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '204':
          description: Folder position updated successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/data/sort:
    put:
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      summary: Sort Data by Columns
      description: Sorts the data in the table based on specified columns.
      operationId: sortDataByColumns
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SortDataByColumnsConfig'
            examples:
              sample:
                value:
                  columns:
                  - '2531676000011845005'
                  - '2531676000011845007'
                  sortOrder: 2
                  resetSort: false
      responses:
        '204':
          description: Data sorted successfully (No Content)
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns:
    post:
      tags:
      - Modeling APIs
      summary: Add Column
      description: This API allows you to add a new column to the specified view.
      operationId: addColumn
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/AddColumnConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      responses:
        '200':
          description: Column added successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddColumnResponse'
              examples:
                success:
                  value:
                    status: success
                    summary: Add column
                    data:
                      columnId: '1767024000003145017'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/{column-id}:
    put:
      tags:
      - Modeling APIs
      summary: Rename Column
      description: This API allows you to rename a column.
      operationId: renameColumn
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - $ref: '#/components/parameters/column-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/RenameColumnConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      responses:
        '204':
          description: Column renamed successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    delete:
      tags:
      - Modeling APIs
      summary: Delete Column
      description: This API deletes the specified column from a view.
      operationId: deleteColumn
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - $ref: '#/components/parameters/column-id'
      requestBody:
        required: false
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/DeleteColumnConfig'
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
      responses:
        '204':
          description: Column deleted successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/{column-id}/lookup:
    post:
      tags:
      - Modeling APIs
      summary: Add Lookup
      description: This API adds a lookup relationship to a column.
      operationId: addLookup
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - $ref: '#/components/parameters/column-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/AddLookupConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      responses:
        '204':
          description: Lookup added successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    delete:
      tags:
      - Modeling APIs
      summary: Remove Lookup
      description: This API removes the lookup relationship from a column.
      operationId: removeLookup
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - $ref: '#/components/parameters/column-id'
      requestBody:
        required: false
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/RemoveLookupConfig'
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
      responses:
        '204':
          description: Lookup removed successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/hide:
    put:
      tags:
      - Modeling APIs
      summary: Hide Columns
      description: This API hides the specified columns in a view.
      operationId: hideColumns
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/HideShowColumnConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      responses:
        '204':
          description: Columns hidden successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/show:
    put:
      tags:
      - Modeling APIs
      summary: Show Columns
      description: This API shows the specified hidden columns in a view.
      operationId: showColumns
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/HideShowColumnConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      responses:
        '204':
          description: Columns shown successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/reorder:
    put:
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      summary: Reorder Columns
      description: Updates the column order of the current table.
      operationId: reorderColumns
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/ReorderColumnsConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '204':
          description: Column order updated successfully (No Content)
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{source-workspace-id}/views/copy:
    post:
      tags:
      - Modeling APIs
      summary: Copy Views
      description: Copy the specified views from one workspace to another workspace.
      operationId: copyViews
      parameters:
      - $ref: '#/components/parameters/org-id'
      - name: ZANALYTICS-DEST-ORGID
        in: header
        required: true
        schema:
          type: string
        description: Id of the organization where the destination workspace is present.
      - name: source-workspace-id
        in: path
        required: true
        schema:
          type: string
        description: Source workspace ID
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/CopyViewsConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      responses:
        '200':
          description: Views copied successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CopyViewsResponse'
              examples:
                success:
                  value:
                    status: success
                    summary: Copy views
                    data:
                      views:
                      - sourceViewId: '1767024000004221089'
                        destViewId: '2102449000000625001'
                      - sourceViewId: '1767024000004221093'
                        destViewId: '2102449000000625005'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/formulas/copy:
    post:
      tags:
      - Modeling APIs
      summary: Copy Formulas
      description: Copy the specified formulas from one table to another across workspaces.
      operationId: copyFormulas
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - name: ZANALYTICS-DEST-ORGID
        in: header
        required: true
        schema:
          type: string
        description: Id of the organization where the destination workspace is present.
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/CopyFormulasConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      responses:
        '204':
          description: Formulas copied successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/similarviews:
    post:
      operationId: createSimilarViews
      summary: Create Similar Views
      description: Create reports for the specified table based on the reference table.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/CreateSimilarViewsConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '204':
          description: No Content. Reports were created successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/autoanalyse:
    post:
      operationId: autoAnalyseView
      summary: Auto Analyse View
      description: Auto generate reports for the specified table.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutoAnalyseViewConfig'
      responses:
        '204':
          description: No Content. Reports were auto generated.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/columns/{column-id}/autoanalyse:
    post:
      operationId: autoAnalyseColumn
      summary: Auto Analyse Column
      description: Auto generate reports for the specified column.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - $ref: '#/components/parameters/column-id'
      responses:
        '204':
          description: No Content. Column reports generated.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/variables:
    get:
      operationId: getVariables
      summary: Get all variables in a workspace
      description: Retrieve a list of all variables created in the specified workspace.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.read
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      responses:
        '200':
          description: Fetches all variables in the workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVariablesResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    post:
      operationId: createVariable
      summary: Create a variable
      description: Create a new variable in the specified workspace using a CONFIG JSON.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/VariableConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '200':
          description: Successfully created variable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVariableResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/variables/{variable-id}:
    get:
      operationId: getVariableDetails
      summary: Get details of a specific variable
      description: Fetch metadata and configuration of a variable using its ID in a workspace.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.read
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/variable-id'
      responses:
        '200':
          description: Returns the variable metadata and configuration details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVariableDetailsResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    put:
      operationId: updateVariable
      summary: Update a variable
      description: Update an existing variable in the specified workspace using the CONFIG JSON.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/variable-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/VariableConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '204':
          description: Variable updated successfully. No response body.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    delete:
      operationId: deleteVariable
      summary: Delete a variable
      description: Delete the specified variable from the workspace.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/variable-id'
      responses:
        '204':
          description: Variable deleted successfully. No response body.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/customformulas:
    post:
      operationId: addFormulaColumn
      summary: Add Formula Column
      description: Add a new formula column to the specified view.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/AddFormulaColumnConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '200':
          description: Successfully added formula column
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddFormulaColumnResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/customformulas/{formula-id}:
    put:
      operationId: editFormulaColumn
      summary: Edit Formula Column
      description: Update an existing formula column in the view.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - $ref: '#/components/parameters/formula-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/EditFormulaColumnConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '204':
          description: Formula column updated successfully. No response body.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    delete:
      operationId: deleteFormulaColumn
      summary: Delete Formula Column
      description: Delete a formula column from the specified view.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - $ref: '#/components/parameters/formula-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/DeleteFormulaColumnConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '204':
          description: Formula column deleted successfully. No response body.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/aggregateformulas:
    post:
      operationId: addAggregateFormula
      summary: Add Aggregate Formula
      description: Add an aggregate formula column to the specified view.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/AddAggregateFormulaConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '200':
          description: Successfully added aggregate formula column
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddAggregateFormulaResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/aggregateformulas/{formula-id}:
    put:
      operationId: editAggregateFormula
      summary: Edit Aggregate Formula
      description: Update an existing aggregate formula column in the view.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - $ref: '#/components/parameters/formula-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/EditAggregateFormulaConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '204':
          description: Aggregate formula column updated successfully. No response body.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    delete:
      operationId: deleteAggregateFormula
      summary: Delete Aggregate Formula
      description: Delete an aggregate formula column from the specified view.
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
      tags:
      - Modeling APIs
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - $ref: '#/components/parameters/formula-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/DeleteAggregateFormulaConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '204':
          description: Aggregate formula column deleted successfully. No response body.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/emailschedules:
    post:
      operationId: createEmailSchedule
      summary: Create Email Schedule
      description: Create an email schedule for a view.
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - name: CONFIG
        in: query
        required: true
        description: JSON string representing the schedule configuration.
        schema:
          $ref: '#/components/schemas/CreateEmailScheduleConfig'
      responses:
        '200':
          description: Successfully created the email schedule.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEmailScheduleResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/emailschedules/{schedule-id}:
    put:
      operationId: updateEmailSchedule
      summary: Update Email Schedule
      description: Update an existing email schedule.
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - name: schedule-id
        in: path
        required: true
        schema:
          type: string
      - name: CONFIG
        in: query
        required: true
        description: JSON string representing the updated schedule configuration.
        schema:
          $ref: '#/components/schemas/UpdateEmailScheduleConfig'
      responses:
        '200':
          description: Successfully created the email schedule.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateEmailScheduleResponse'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
    delete:
      operationId: deleteEmailSchedule
      summary: Delete Email Schedule
      description: Delete the specified email schedule.
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - name: schedule-id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Email schedule deleted successfully. No content.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/emailschedules/{schedule-id}/trigger:
    post:
      operationId: triggerEmailSchedule
      summary: Trigger Email Schedule
      description: Manually trigger the specified email schedule.
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - name: schedule-id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Schedule triggered successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/workspaces/{workspace-id}/views/{view-id}/emailschedules/{schedule-id}/status:
    put:
      operationId: changeEmailScheduleStatus
      summary: Change Email Schedule Status
      description: Enable or disable the specified email schedule.
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.update
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/view-id'
      - $ref: '#/components/parameters/schedule-id'
      - name: CONFIG
        in: query
        required: true
        description: JSON string with schedule status (enabled or disabled).
        schema:
          $ref: '#/components/schemas/ChangeEmailScheduleStatusConfig'
      responses:
        '204':
          description: Schedule status updated successfully.
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/automl/workspaces/{workspace-id}/analysis:
    post:
      tags:
      - Modeling APIs
      summary: Create AutoML Analysis
      description: Creates a new AutoML analysis within the workspace.
      operationId: createAutoMLAnalysis
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/CreateAutoMLAnalysisConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '200':
          description: AutoML analysis created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAutoMLAnalysisResponse'
              examples:
                success:
                  value:
                    status: success
                    summary: Create autoML analysis
                    data:
                      id: '466206000000178110'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}/models/{model-id}/deployments:
    post:
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      summary: Create AutoML Analysis Deployment
      description: Create a deployment for an AutoML analysis model.
      operationId: createAutoMLAnalysisDeployment
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/analysis-id'
      - $ref: '#/components/parameters/model-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/CreateAutoMLAnalysisDeploymentConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '200':
          description: AutoML analysis deployment created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAutoMLAnalysisDeploymentResponse'
              examples:
                success:
                  value:
                    status: success
                    summary: Create autoML analysis deployment
                    data:
                      deployments:
                        outputTableId: '466206000000198129'
                        deploymentId: '466206000000198176'
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}/models/{model-id}/whatif:
    post:
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      summary: AutoML What If Analysis
      description: Generate predictions using a trained AutoML model.
      operationId: autoMLWhatIfAnalysis
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/analysis-id'
      - $ref: '#/components/parameters/model-id'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CONFIG:
                  $ref: '#/components/schemas/AutoMLWhatIfAnalysisConfig'
              required:
              - CONFIG
            encoding:
              CONFIG:
                contentType: application/json
      responses:
        '200':
          description: What-If analysis completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoMLWhatIfAnalysisResponse'
              examples:
                success:
                  value:
                    status: success
                    summary: AutoML what if analysis
                    data:
                      predictions: '1000'
                      targetColumn: Sales
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}/deployments/{deployment-id}/execute:
    post:
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.create
      summary: Run AutoML Analysis
      description: Execute an AutoML analysis deployment.
      operationId: runAutoMLAnalysis
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/analysis-id'
      - $ref: '#/components/parameters/deployment-id'
      responses:
        '204':
          description: AutoML analysis deployment executed successfully (No Content)
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}/deployments/{deployment-id}:
    delete:
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
      summary: Delete AutoML Analysis Model Deployment
      description: Delete an AutoML analysis deployment.
      operationId: deleteAutoMLAnalysisModelDeployment
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/analysis-id'
      - $ref: '#/components/parameters/deployment-id'
      responses:
        '204':
          description: AutoML analysis deployment deleted successfully (No Content)
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}/models/{model-id}:
    delete:
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
      summary: Delete AutoML Analysis Model
      description: Delete a specific model from an AutoML analysis.
      operationId: deleteAutoMLAnalysisModel
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/analysis-id'
      - $ref: '#/components/parameters/model-id'
      responses:
        '204':
          description: AutoML analysis model deleted successfully (No Content)
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
  /restapi/v2/automl/workspaces/{workspace-id}/analysis/{analysis-id}:
    delete:
      tags:
      - Modeling APIs
      security:
      - iam-oauth2-schema:
        - ZohoAnalytics.modeling.delete
      summary: Delete AutoML Analysis
      description: Delete a specified AutoML analysis from the workspace.
      operationId: deleteAutoMLAnalysis
      parameters:
      - $ref: '#/components/parameters/org-id'
      - $ref: '#/components/parameters/workspace-id'
      - $ref: '#/components/parameters/analysis-id'
      responses:
        '204':
          description: AutoML analysis deleted successfully (No Content)
        default:
          $ref: https://raw.githubusercontent.com/zoho/analytics-oas/refs/heads/main/v2.0/zoho-analytics-api-common.json#/components/responses/CommonErrorResponse
components:
  schemas:
    CreateEmailScheduleConfig:
      type: object
      properties:
        scheduleName:
          type: string
          description: Name of the schedule
        viewIds:
          type: array
          items:
            type: string
          description: View ids to be shared
        exportType:
          type: string
          enum:
          - csv
          - xls
          - img
          - pdf
          - html
          description: The type of export
        scheduleDetails:
          type: object
          description: Detailed scheduling configuration
          properties:
            calendarFrequency:
              type: string
              enum:
              - daily
              - weekly
              - monthly
              - yearly
            hour:
              type: integer
              minimum: 0
              maximum: 23
            minute:
              type: integer
              enum:
              - 0
              - 5
              - 10
              - 15
              - 20
              - 25
              - 30
              - 35
              - 40
              - 45
              - 50
              - 55
            weekDay:
              type: integer
              minimum: 1
              maximum: 7
            weekDays:
              type: array
              items:
                type: integer
                minimum: 1
                maximum: 7
            weekNumber:
              type: integer
              minimum: 1
              maximum: 5
            monthDay:
              type: integer
            monthDays:
              type: array
              items:
                type: integer
            months:
              type: array
              items:
                type: integer
                minimum: 1
                maximum: 12
          required:
          - calendarFrequency
          - hour
          - minute
        emailIds:
          type: array
          items:
            type: string
            format: email
        groupIds:
          type: array
          items:
            type: string
        cc:
          type: object
          properties:
            emailIds:
              type: array
              items:
                type: string
                format: email
            groupIds:
              type: array
              items:
                type: string
        applyShareCriteria:
          type: boolean
          default: false
        applyDefaultUf:
          type: boolean
          default: false
        subject:
          type: string
        message:
          type: string
      required:
      - scheduleName
      - viewIds
      - exportType
      - scheduleDetails
      examples:
      - scheduleName: Monthly Report
        viewIds:
        - '1234567890123'
        exportType: pdf
        scheduleDetails:
          calendarFrequency: monthly
          hour: 9
          minute: 0
          monthDays:
          - 1
          - 15
          months:
          - 1
          - 6
          - 12
        emailIds:
        - user1@example.com
        groupIds:
        - group123
        cc:
          emailIds:
          - manager@example.com
          groupIds:
          - group456
        applyShareCriteria: true
        applyDefaultUf: false
        subject: Monthly Financial Summary
        message: Please find the attached monthly report.
    AutoAnalyseViewConfig:
      type: object
      description: Configuration for auto-analysing a view.
      properties:
        analyseAgain:
          type: boolean
          description: Generate duplicate reports if already generated.
      examples:
      - analyseAgain: true
    RenameColumnConfig:
      type: object
      properties:
        columnName:
          type: string
          description: The new name of the column.
      required:
      - columnName
      examples:
      - columnName: New Column Name
    CopyWorkspaceConfig:
      type: object
      properties:
        newWorkspaceName:
          type: string
        newWorkspaceDesc:
          type: string
        workspaceKey:
          type: string
        copyWithData:
          type: boolean
        copyWithImportSource:
          type: boolean
      required:
      - newWorkspaceName
      examples:
      - newWorkspaceName: Cloned Workspace
        copyWithData: true
    VariableConfig:
      type: object
      properties:
        variableName:
          type: string
        variableType:
          type: integer
          enum:
          - 0
          - 1
          - 3
        variableDataType:
          type: integer
          enum:
          - 1
          - 4
          - 5
          - 6
          - 7
          - 8
        format:
          $ref: '#/components/schemas/VariableFormat'
        userSpecificData:
          type: array
          items:
            $ref: '#/components/schemas/UserSpecificVariableData'
        defaultData:
          $ref: '#/components/schemas/DefaultVariableData'
      required:
      - variableName
      - variableType
      - variableDataType
    CreateReportConfig:
      type: object
      properties:
        baseTableName:
          type: string
          description: Name of the base table used to create report.
        title:
          type: string
          description: Name of the report.
        description:
          type: string
          description: Description of the report.
        reportType:
          type: string
          description: Specifies the type of report to be created.
          enum:
          - chart
          - pivot
          - summary
        chartType:
          type: string
          description: Specifies the type of chart to be created.
          enum:
          - area
          - area with points
          - area without points
          - smooth area
          - smooth area with points
          - smooth area without points
          - stacked area
          - stacked area with points
          - stacked smooth area
          - stacked smooth area with points
          - stacked smooth area without points
          - bar
          - horizontal bar
          - stacked bar
          - horizontal stacked bar
          - bubble
          - packed bubble
          - combo
          - combo bar with smooth line
          - funnel
          - pyramid
          - line
          - line with points
          - line without points
          - smooth line
          - smooth line with points
          - smooth line without points
          - step
          - map area
          - map bubble
          - map filled
          - map pie
          - map pie bubble
          - map bubble pie
          - map scatter
          - geo heat map
          - pie
          - ring
          - semi pie
          - semi ring
          - scatter
          - web
          - web with fill
          - web without fill
          - heat map
          - butterfly
          - table chart
        axisColumns:
          type: array
          description: Details of the columns like type, column name, and functions used.
          items:
            $ref: '#/components/schemas/AxisColumn'
        filters:
          type: array
          description: Filter conditions to be applied to the report.
          items:
            $ref: '#/components/schemas/FilterColumn'
        userFilters:
          type: array
          description: User-defined filters for report customization.
          items:
            $ref: '#/components/schemas/FilterColumn'
        isAxisMerge:
          type: string
          enum:
          - 'true'
          - 'false'
          description: Gives information about merge axis.
        mergeAxisInfo:
          type: string
          description: 'Details about merged Y-axis. Example: {"axisIndex":[2,3],"labelName":"Merge_axis"}'
      required:
      - baseTableName
      - title
      - reportType
      - axisColumns
      examples:
      - baseTableName: Sales
        title: Sales By Region
        reportType: chart
        description: Shows regional sales performance
        axisColumns:
        - type: xAxis
          columnName: Region
          operation: year
        - type: yAxis
          columnName: Sales
          operation: sum
    CreateWorkspaceConfig:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace
        workspaceDesc:
          type: string
          description: Optional description for the workspace
      required:
      - workspaceName
      examples:
      - workspaceName: Sales Analytics
        workspaceDesc: Workspace for quarterly sales
    CopyViewsConfig:
      type: object
      properties:
        viewIds:
          type: array
          items:
            type: string
          description: The ID of the views to be copied.
        destWorkspaceId:
          type: string
          description: The destination workspace ID.
        workspaceKey:
          type: string
          description: Secret key to allow copying between organizations.
        copyWithData:
          type: boolean
          description: Whether to copy the data along with views.
        copyWithDependentViews:
          type: boolean
          description: Whether to copy dependent views.
      required:
      - viewIds
      - destWorkspaceId
      examples:
      - viewIds:
        - '2102449000000678001'
        - '2102449000000679001'
        destWorkspaceId: '1767024000003145002'
    CreateAutoMLAnalysisDeploymentConfig:
      type: object
      properties:
        inputTableId:
          type: integer
          description: Unique ID of the input table from which data will be read for AutoML analysis deployment.
          maxLength: 60
        outputTable:
          type: string
          description: Name of the output table where the prediction results will be stored.
        scheduleDetails:
          type: object
          properties:
            calendarFrequency:
              type: string
              enum:
              - none
              - hourly
              - daily
              - weekly
              - monthly
              description: Defines the frequency at which the deployment job should run.
            interval:
              type: integer
              description: Specifies the interval for the schedule based on calendarFrequency.
            hour:
              type: integer
              description: Specifies the hour of the day (0-23) when the deployment job should be triggered.
            hourInterval:
              type: integer
              description: Specifies the hour interval between executions when applicable.
            minute:
              type: integer
              description: Specifies the minute within the hour (0-59) when the deployment job should be triggered.
            weekDay:
              type: integer
              description: Specifies the day of the week when the deployment job should be triggered.
              enum:
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
            monthDay:
              type: integer
              description: Specifies a particular day of the month when the deployment job should be triggered.
              enum:
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
              - 11
              - 12
              - 13
              - 14
              - 15
              - 16
              - 17
              - 18
              - 19
              - 20
              - 21
              - 22
              - 23
              - 24
              - 25
              - 26
              - 27
              - 28
              - 29
              - 30
              - 31
              - 99
          required:
          - calendarFrequency
        outputColumns:
          type: array
          items:
            type: string
            description: Each value must be a valid column name.
          minItems: 1
          maxItems: 100
          description: List of column names that will be written to the output table as part of the prediction results.
        predictionColumn:
          type: string
          description: Name of the column for which predictions will be generated.
        serverOption:
          type: integer
          enum:
          - 1
          - 2
          - 3
          description: Specifies the server memory configuration for executing the AutoML deployment job.
        timezone:
          type: string
          description: Timezone to be used for scheduling the deployment job.
        importType:
          type: string
          enum:
          - APPEND
          - TRUNCATEADD
          - UPDATEADD
          description: Specifies how prediction results should be imported into the output table.
        matchingColumns:
          type: array
          items:
            type: string
            description: Each value must be a valid column name.
          description: List of column names used to match existing records in the output table when importType is UPDATEADD.
      required:
      - inputTableId
      - outputTable
      - scheduleDetails
      - outputColumns
      - predictionColumn
      - serverOption
      - importType
      examples:
      - inputTableId: 196355000003252000
        outputTable: SalesDep
        outputColumns:
        - Sales
        - Product
        predictionColumn: precol
        serverOption: 1
        importType: append
        scheduleDetails:
          calendarFrequency: hourly
          interval: 3
    CopyViewsResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            views:
              type: array
              items:
                type: object
                properties:
                  sourceViewId:
                    type: string
                    description: ID of the source view.
                  destViewId:
                    type: string
                    description: ID of the copied destination view.
      examples:
      - status: success
        summary: Copy views
        data:
          views:
          - sourceViewId: '1767024000004221089'
            destViewId: '2102449000000625001'
          - sourceViewId: '1767024000004221093'
            destViewId: '2102449000000625005'
    CreateTableResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            viewId:
              type: string
      examples:
      - status: success
        summary: Create table
        data:
          viewId: '1767024000003145011'
    AddLookupConfig:
      type: object
      properties:
        referenceViewId:
          type: string
          description: The reference view ID.
        referenceColumnId:
          type: string
          description: The reference column ID.
      required:
      - referenceViewId
      - referenceColumnId
      examples:
      - referenceViewId: '1767024000003145012'
        referenceColumnId: '1767024000003145013'
    AddAggregateFormulaResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            formulaId:
              type: string
            formulaName:
              type: string
      examples:
      - summary: Aggregate formula created successfully
        value:
          status: success
          summary: Create aggregate formula
          data:
            formulaId: '1767024000009137000'
            formulaName: AF1
    DefaultVariableData:
      type: object
      properties:
        values:
          type: array
          items:
            type: string
        defaultValue:
          type: string
        minValue:
          type: string
        maxValue:
          type: string
        stepSize:
          type: string
    AutoMLWhatIfAnalysisResponse:
      type: object
      properties:
        status:
          type: string
          description: Status of the What-If analysis.
        summary:
          type: string
          description: Summary of the What-If analysis.
        data:
          type: object
          properties:
            predictions:
              type: string
              description: Predicted value based on the What-If analysis.
            targetColumn:
              type: string
              description: Name of the target column for which predictions were generated.
      examples:
      - status: success
        summary: AutoML what if analysis
        data:
          predictions: '1000'
          targetColumn: Sales
    UpdateEmailScheduleResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            scheduleId:
              type: string
      examples:
      - status: success
        summary: Update email schedule
        data:
          scheduleId: '1767024000010887001'
    SaveAsViewResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            viewId:
              type: string
      examples:
      - status: success
        summary: Saveas view
        data:
          viewId: '1767024000004723001'
    SortDataByColumnsConfig:
      type: object
      properties:
        columns:
          type: array
          items:
            type: string
          description: List of column IDs to sort by.
        sortOrder:
          type: integer
          enum:
          - 1
          - 2
          description: Sorting order (1 → Ascending, 2 → Descending).
        resetSort:
          type: boolean
          description: If true, resets existing sort configuration. Default - false.
          default: false
      required:
      - columns
      - sortOrder
      examples:
      - columns:
        - '2531676000011845005'
        - '2531676000011845007'
        sortOrder: 2
        resetSort: false
    CreateQueryTableConfig:
      type: object
      properties:
        sqlQuery:
          type: string
          description: SQL query to construct the query table.
        queryTableName:
          type: string
          description: Name of the query table to be created.
        description:
          type: string
          description: Description of the query table.
        folderId:
          type: string
          description: Id of the folder where the query table has to be created.
      required:
      - sqlQuery
      - queryTableName
      examples:
      - sqlQuery: SELECT * FROM Sales
        queryTableName: Sales Summary
    CreateAutoMLAnalysisConfig:
      type: object
      properties:
        name:
          type: string
          description: Name of the analysis template.
          maxLength: 60
        description:
          type: string
          description: Detailed description of the analysis template.
          maxLength: 1000
        trainingTableId:
          type: integer
          format: int64
          description: Unique ID of the training table used to build the analysis model.
        targetColumn:
          type: string
          description: Name of the target column from the training table that the model will predict.
        predictionType:
          type: string
          description: Type of prediction to be performed by the model.
          enum:
          - REGRESSION
          - CLASSIFICATION
          - CLUSTERING
        features:
          type: array
          description: List of column names from the training table to use as input features.
          items:
            type: string
            description: Each value must be a valid column name.
          minItems: 1
          maxItems: 100
        serverOption:
          type: integer
          description: Specifies the server memory option.
          enum:
          - 1
          - 2
          - 3
        algorithms:
          type: object
          description: Configuration for algorithms to be used for training.
          properties:
            decisionTreeRegression:
              type: object
              properties:
                minimumSampleSplit:
                  type: integer
                maximumDepth:
                  type: integer
            randomForestRegression:
              type: object
              properties:
                minimumSampleSplit:
                  type: integer
                maximumDepth:
                  type: integer
                numberOfTrees:
                  type: integer
            olsRegression:
              type: object
              properties:
                intercept:
                  type: boolean
                allowAlternateModel:
                  type: boolean
            lassoRegression:
              type: object
              properties:
                tolerance:
                  type: number
                shrinkage:
                  type: integer
                maximumIterations:
                  type: integer
            ridgeRegression:
              type: object
              properties:
                shrinkage:
                  type: integer
            svmRegressor:
              type: object
              properties:
                epsilon:
                  type: number
                softMargin:
                  type: number
                tolerance:
                  type: number
                epochs:
                  type: integer
            gradientBoostingRegression:
              type: object
              properties:
                lossFunction:
                  type: string
                  enum:
                  - LEASTSQUARES
                  - QUANTILE
                  - LEASTABSOLUTEDEVIATION
                  - HUBER
                maximumDepth:
                  type: integer
                maximumNodes:
                  type: integer
                nodeSize:
                  type: integer
                numberOfTrees:
                  type: integer
                shrinkage:
                  type: number
                subSample:
                  type: number
            gradientBoostingClassification:
              type: object
              properties:
                lossFunction:
                  type: string
                  enum:
                  - LEASTSQUARES
                  - QUANTILE
                  - LEASTABSOLUTEDEVIATION
                  - HUBER
                maximumDepth:
                  type: integer
                maximumNodes:
                  type: integer
                nodeSize:
                  type: integer
                numberOfTrees:
                  type: integer
                shrinkage:
                  type: number
                subSample:
                  type: number
            adaptiveBoost:
              type: object
              properties:
                maximumDepth:
                  type: integer
                maximumNodes:
                  type: integer
                nodeSize:
                  type: integer
                numberOfTrees:
                  type: integer
            decisionTreeClassification:
              type: object
              properties:
                minimumSampleSplit:
                  type: integer
                maximumDepth:
                  type: integer
            randomForestClassification:
              type: object
              properties:
                minimumSampleSplit:
                  type: integer
                maximumDepth:
                  type: integer
                numberOfTrees:
                  type: integer
            logisticRegression:
              type: object
              properties:
                lambda:
                  type: number
                maximumIterations:
                  type: integer
                tolerance:
                  type: number
            linearDiscriminantAnalysis:
              type: object
              properties:
                tolerance:
                  type: number
            maxEntropy:
              type: object
              properties:
                lambda:
                  type: number
                maximumIterations:
                  type: integer
                tolerance:
                  type: number
            kMeansPP:
              type: object
              properties:
                clustersCount:
                  type: integer
                kMax:
                  type: integer
                chIndexBasedOptimalK:
                  type: boolean
                calculatePerformanceMetrics:
                  type: boolean
            kModes:
              type: object
              properties:
                clustersCount:
                  type: integer
                minimumClusterCount:
                  type: integer
                maximumClusterCount:
                  type: integer
                dissimilarityMeasure:
                  type: string
                  enum:
                  - BINARY
                  - GLOBAL_FREQUENCY
                  - RELATIVE_FREQUENCY
                  - JARO_WINKLER
                  - LEVENSHTEIN
                  - JACCARD
            kPrototypes:
              type: object
              properties:
                clustersCount:
                  type: integer
                kMax:
                  type: integer
                chIndexBasedOptimalK:
                  type: boolean
                gamma:
                  type: number
            xMeans:
              type: object
              properties:
                kMax:
                  type: integer
                maximumIterations:
                  type: integer
                tolerance:
                  type: number
            gMeans:
              type: object
              properties:
                kMax:
                  type: integer
                maximumIterations:
                  type: integer
                tolerance:
                  type: number
      required:
      - name
      - trainingTableId
      - predictionType
      - features
      - serverOption
      - algorithms
      examples:
      - name: Analysis-1
        trainingTableId: 2531676000011845000
        targetColumn: Sales
        predictionType: CLASSIFICATION
        features:
        - Cost
        - Region
        - Product
        serverOption: 1
        algorithms:
          decisionTreeClassification:
            minimumSampleSplit: 2
            maximumDepth: 2
          randomForestClassification:
            minimumSampleSplit: 2
            maximumDepth: 2
            numberOfTrees: 25
    DeleteFolderConfig:
      type: object
      properties:
        deleteDependentViews:
          type: boolean
          description: Delete the views along with their dependents present in the folder. Default value - false.
      examples:
      - deleteDependentViews: true
    UpdateReportConfig:
      type: object
      properties:
        title:
          type: string
          description: New name for the report.
        description:
          type: string
          description: New description for the report.
        reportType:
          type: string
          enum:
          - chart
          - pivot
          - summary
          description: Updated type of the report.
        axisColumns:
          type: array
          items:
            $ref: '#/components/schemas/AxisColumn'
        filters:
          type: array
          items:
            $ref: '#/components/schemas/FilterColumn'
        userFilters:
          type: array
          items:
            $ref: '#/components/schemas/FilterColumn'
        isAxisMerge:
          type: string
          enum:
          - 'true'
          - 'false'
        mergeAxisInfo:
          type: string
      required:
      - axisColumns
      examples:
      - title: Updated Sales Report
        reportType: chart
        axisColumns:
        - type: xAxis
          columnName: Date
          operation: month
        - type: yAxis
          columnName: Revenue
          operation: sum
    DeleteAggregateFormulaConfig:
      type: object
      properties:
        deleteDependentViews:
          type: boolean
          description: To delete the column along with dependent views. Default is false
      examples:
      - summary: Delete aggregate formula
        value:
          deleteDependentViews: true
    FilterColumn:
      type: object
      properties:
        tableName:
          type: string
          description: Name of the table the filter column belongs to.
        columnName:
          type: string
          description: Name of the column used for filtering.
        operation:
          type: string
          description: Function applied to the column in the filter.
      required:
      - tableName
      - columnName
      - operation
    AddFormulaColumnResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            formulaId:
              type: string
            formulaName:
              type: string
      examples:
      - summary: Formula column created successfully
        value:
          status: success
          summary: Create Formula Column
          data:
            formulaId: '1767024000009120246'
            formulaName: F1
    CreateFolderResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            folderId:
              type: string
      examples:
      - status: success
        summary: Create folder
        data:
          folderId: '1767024000004578011'
    UpdateEmailScheduleConfig:
      type: object
      properties:
        scheduleName:
          type: string
          description: Name of the schedule
        scheduleDetails:
          type: object
          description: Detailed scheduling configuration
          properties:
            calendarFrequency:
              type: string
              enum:
              - daily
              - weekly
              - monthly
              - yearly
            hour:
              type: integer
              minimum: 0
              maximum: 23
            minute:
              type: integer
              enum:
              - 0
              - 5
              - 10
              - 15
              - 20
              - 25
              - 30
              - 35
              - 40
              - 45
              - 50
              - 55
            weekDay:
              type: integer
              minimum: 1
              maximum: 7
            weekDays:
              type: array
              items:
                type: integer
                minimum: 1
                maximum: 7
            weekNumber:
              type: integer
              minimum: 1
              maximum: 5
            monthDay:
              type: integer
            monthDays:
              type: array
              items:
                type: integer
            months:
              type: array
              items:
                type: integer
                minimum: 1
                maximum: 12
          required:
          - calendarFrequency
          - hour
          - minute
        emailIds:
          type: array
          items:
            type: string
            format: email
        groupIds:
          type: array
          items:
            type: string
        cc:
          type: object
          properties:
            emailIds:
              type: array
              items:
                type: string
                format: email
            groupIds:
              type: array
              items:
                type: string
        subject:
          type: string
        message:
          type: string
      required:
      - scheduleName
      - scheduleDetails
      examples:
      - scheduleName: Updated Monthly Report
        scheduleDetails:
          calendarFrequency: daily
          hour: 10
          minute: 30
        subject: Daily Sales Overview
        emailIds:
        - sales@example.com
        groupIds:
        - group789
        cc:
          emailIds:
          - admin@example.com
          groupIds:
          - group999
        message: Here's your updated schedule report.
    CreateAutoMLAnalysisDeploymentResponse:
      type: object
      properties:
        status:
          type: string
          description: Status of the deployment creation.
        summary:
          type: string
          description: Summary of the deployment creation.
        data:
          type: object
          properties:
            deployments:
              type: object
              properties:
                outputTableId:
                  type: string
                  description: ID of the output table where predictions are stored.
                deploymentId:
                  type: string
                  description: ID of the created deployment.
      examples:
      - status: success
        summary: Create autoML analysis deployment
        data:
          deployments:
            outputTableId: '466206000000198129'
            deploymentId: '466206000000198176'
    DeleteViewConfig:
      type: object
      properties:
        deleteDependentViews:
          type: boolean
          description: To delete dependent views while deleting a table/querytable.
      examples:
      - deleteDependentViews: true
    ChangeFolderHierarchyConfig:
      type: object
      properties:
        hierarchy:
          type: integer
          description: New hierarchy for the folder. (0 - Parent; 1 - Child)
          enum:
          - 0
          - 1
        parentFolderId:
          type: string
          description: Id of the parent folder. (Mandatory when moving a folder as child)
      required:
      - hierarchy
      examples:
      - hierarchy: 1
        parentFolderId: '1767024000004578021'
    DeleteColumnConfig:
      type: object
      properties:
        deleteDependentViews:
          type: boolean
          description: If true, deletes the dependent views as well. Default is false.
      examples:
      - deleteDependentViews: true
    RestoreTrashViewConfig:
      type: object
      properties:
        withDependents:
          type: boolean
          description: 'To restore the view along with its dependent views. Default value: false.'
      examples:
      - withDependents: true
    HideShowColumnConfig:
      type: object
      properties:
        columnIds:
          type: array
          description: List of column IDs to hide or show.
          items:
            type: string
      required:
      - columnIds
      examples:
      - columnIds:
        - '1767024000003145015'
        - '1767024000003145016'
    CreateSimilarViewsConfig:
      type: object
      description: Configuration for creating similar views based on a reference view.
      properties:
        referenceViewId:
          type: string
          description: The reference view ID.
        folderId:
          type: string
          description: The folder ID where the views will be saved.
        copyCustomFormula:
          type: boolean
          description: 'To copy the custom formulas present in the parent view. Default: false.'
        copyAggFormula:
          type: boolean
          description: 'To copy the aggregate formulas present in the parent view. Default: false.'
      required:
      - referenceViewId
      - folderId
      examples:
      - referenceViewId: '1234567890001'
        folderId: '9876543210002'
        copyCustomFormula: true
        copyAggFormula: false
    GetVariablesResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            variables:
              type: array
              items:
                type: object
                properties:
                  variableId:
                    type: string
                  variableName:
                    type: string
                  variableType:
                    type: string
                  variableDataType:
                    type: string
      examples:
      - status: success
        summary: Get variables
        data:
          variables:
          - variableName: Variable - 1
            variableId: '137687000007146340'
            variableType: '0'
            variableDataType: '1'
          - variableName: Variable - 2
            variableId: '137687000007146338'
            variableType: '3'
            variableDataType: '1'
    RemoveLookupConfig:
      type: object
      properties:
        deleteDependentViews:
          type: boolean
          description: Delete the dependent views created based on the lookup relation. Default is false.
      examples:
      - deleteDependentViews: true
    LookupColumnDesign:
      type: object
      properties:
        TABLENAME:
          type: string
          description: The name of the lookup table.
        COLUMNNAME:
          type: string
          description: The name of the column in the lookup table.
      required:
      - TABLENAME
      - COLUMNNAME
    EditAggregateFormulaConfig:
      type: object
      properties:
        expression:
          type: string
          description: Updated aggregate formula expression
        description:
          type: string
          description: Updated description of the aggregate formula column
      required:
      - expression
      examples:
      - summary: Edit aggregate formula column
        value:
          expression: avg("Sales")
          description: Average Sales
    ChangeFolderPositionConfig:
      type: object
      properties:
        referenceFolderId:
          type: string
          description: Id of the folder that will be used as the reference for the new position.
      required:
      - referenceFolderId
      examples:
      - referenceFolderId: '1767024000004578032'
    CreateEmailScheduleResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            scheduleId:
              type: string
      examples:
      - status: success
        summary: Create Email Schedule
        data:
          scheduleId: '1767024000010886001'
    SaveAsViewConfig:
      type: object
      properties:
        viewName:
          type: string
          description: The name of the new view.
        viewDesc:
          type: string
          description: The description of the new view.
        copyWithData:
          type: boolean
          description: To copy table with data.
        copyWithLookup:
          type: boolean
          description: To copy table with lookup details.
        folderId:
          type: string
          description: The folder ID where the created view should be placed.
      required:
      - viewName
      examples:
      - viewName: Cloned Sales Table
        copyWithData: true
        copyWithLookup: false
        folderId: '176702200001018000'
    CopyWorkspaceResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            workspaceId:
              type: string
      examples:
      - status: success
        summary: Copy workspace
        data:
          workspaceId: '1767024000003145006'
    CreateWorkspaceResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            workspaceId:
              type: string
      examples:
      - status: success
        summary: Create workspace
        data:
          workspaceId: '1767024000003145002'
    CreateFolderConfig:
      type: object
      properties:
        folderName:
          type: string
          description: The name of the folder.
        folderDesc:
          type: string
          description: The description of the folder.
        parentFolderId:
          type: string
          description: Id of the parent folder. Newly created folder will be placed under this folder.
        makeDefaultFolder:
          type: boolean
          description: Make the created folder as default. Default value - false.
      required:
      - folderName
      examples:
      - folderName: My Tables
        folderDesc: Folder for storing new tables
        parentFolderId: '1767024000004536004'
        makeDefaultFolder: true
    AddColumnConfig:
      type: object
      properties:
        columnName:
          type: string
          description: The name of the column.
        dataType:
          type: string
          description: The data type of the column.
          enum:
          - PLAIN
          - MULTI_LINE
          - EMAIL
          - NUMBER
          - POSITIVE_NUMBER
          - DECIMAL_NUMBER
          - CURRENCY
          - PERCENT
          - DATE
          - BOOLEAN
          - URL
          - AUTO_NUMBER
          - GEO
          - DURATION
        isPIIColumn:
          type: boolean
          description: To mark as personal data column. Default is false.
        geoRole:
          type: integer
          description: To specify the geo location type. Required if dataType is GEO.
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
      required:
      - columnName
      - dataType
      examples:
      - columnName: Region
        dataType: GEO
        isPIIColumn: false
        geoRole: 2
    RenameWorkspaceConfig:
      type: object
      properties:
        workspaceName:
          type: string
          description: New name of the workspace
      required:
      - workspaceName
      examples:
      - workspaceName: Q4 Sales Workspace
    VariableFormat:
      type: object
      properties:
        alignment:
          type: string
          enum:
          - Left
          - Center
          - Right
        decimalPlaces:
          type: integer
          minimum: -1
          maximum: 10
        currencySymbol:
          type: string
        showNegativeSign:
          type: boolean
        userLocale:
          type: boolean
        thousandSeparator:
          type: integer
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
        decimalSeparator:
          type: integer
          enum:
          - 0
          - 1
        showPercent:
          type: boolean
    AddAggregateFormulaConfig:
      type: object
      properties:
        formulaName:
          type: string
          description: Name of the aggregate formula column to be created
        expression:
          type: string
          description: Aggregate formula expression
        description:
          type: string
          description: Description of the aggregate formula column
      required:
      - formulaName
      - expression
      examples:
      - summary: Add aggregate formula column
        value:
          formulaName: AF1
          expression: sum("Sales")
          description: Total Sales
    GetVariableDetailsResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            variableId:
              type: string
            variableName:
              type: string
            variableType:
              type: integer
            variableDataType:
              type: integer
            format:
              $ref: '#/components/schemas/VariableFormat'
            userSpecificData:
              type: array
              items:
                $ref: '#/components/schemas/UserSpecificVariableData'
            defaultData:
              $ref: '#/components/schemas/DefaultVariableData'
    CreateVariableResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            variableId:
              type: string
      examples:
      - status: success
        summary: Create variable
        data:
          variableId: '137687000006991651'
    CreateQueryTableResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            viewId:
              type: string
      examples:
      - status: success
        summary: Create QueryTable
        data:
          viewId: '176702400000912004'
    CreateAutoMLAnalysisResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            id:
              type: string
              description: ID of the created analysis.
      examples:
      - status: success
        summary: Create autoML analysis
        data:
          id: '466206000000178110'
    CopyFormulasConfig:
      type: object
      properties:
        formulaColumnNames:
          type: array
          items:
            type: string
          description: The names of the formula columns to be copied.
        destWorkspaceId:
          type: string
          description: The destination workspace ID.
        workspaceKey:
          type: string
          description: Secret key to allow copying formulas across orgs.
      required:
      - formulaColumnNames
      - destWorkspaceId
      examples:
      - formulaColumnNames:
        - Avg_Cost
        - Avg_Sales
        destWorkspaceId: '1767024000003145002'
    TableDesign:
      type: object
      properties:
        TABLENAME:
          type: string
          description: The name of the table
        TABLEDESCRIPTION:
          type: string
          description: The description of the table
        FOLDERNAME:
          type: string
          description: The folder where the table is created
        COLUMNS:
          type: array
          items:
            $ref: '#/components/schemas/ColumnDesign'
      required:
      - TABLENAME
      - COLUMNS
    EditFormulaColumnConfig:
      type: object
      properties:
        expression:
          type: string
          description: Updated formula expression
        description:
          type: string
          description: Updated description of the formula column
      required:
      - expression
      examples:
      - summary: Edit formula column
        value:
          expression: '"Sales" - "Cost" + "Adjustment"'
          description: Updated gross profit formula
    RenameFolderConfig:
      type: object
      properties:
        folderName:
          type: string
          description: New name for the folder.
        folderDesc:
          type: string
          description: New description for the folder.
      required:
      - folderName
      examples:
      - folderName: Archived Reports
        folderDesc: All old reporting dashboards
    EditQueryTableConfig:
      type: object
      properties:
        sqlQuery:
          type: string
          description: New SQL query to be updated.
        folderId:
          type: string
          description: Id of the folder where the query table has to be moved.
      required:
      - sqlQuery
      examples:
      - sqlQuery: SELECT Region, SUM(Amount) FROM Sales GROUP BY Region
    DeleteTrashViewConfig:
      type: object
      properties:
        withDependents:
          type: boolean
          description: 'To remove the view along with its dependents from trash. Default value: false.'
      examples:
      - withDependents: false
    RenameViewConfig:
      type: object
      properties:
        viewName:
          type: string
          description: The new name of the view.
        viewDesc:
          type: string
          description: The new description of the view.
      required:
      - viewName
      examples:
      - viewName: Renamed Sales View
        viewDesc: View renamed for clarity
    AxisColumn:
      type: object
      properties:
        type:
          type: string
          description: Defines the role of the column in the report.
          enum:
          - xAxis
          - yAxis
          - textAxis
          - colorAxis
          - toolTip
          - row
          - column
          - data
          - groupBy
          - summarize
        columnName:
          type: string
          description: Name of the column used in the report.
        operation:
          type: string
          description: Function applied to the column. Options vary by data type.
      required:
      - type
      - columnName
      - operation
    AddFormulaColumnConfig:
      type: object
      properties:
        formulaName:
          type: string
          description: Name of the formula column to be created
        expression:
          type: string
          description: Formula expression
        description:
          type: string
          description: Description of the formula column
      required:
      - formulaName
      - expression
      examples:
      - summary: Add formula column
        value:
          formulaName: F1
          expression: '"Sales" - "Cost"'
          description: Gross Profit
    CreateTableConfig:
      type: object
      properties:
        tableDesign:
          $ref: '#/components/schemas/TableDesign'
      required:
      - tableDesign
      examples:
      - tableDesign:
          TABLENAME: Sales
          TABLEDESCRIPTION: Test
          COLUMNS:
          - COLUMNNAME: Column1
            DATATYPE: PLAIN
          - COLUMNNAME: Column2
            DATATYPE: NUMBER
    CreateReportResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            viewId:
              type: string
      examples:
      - status: success
        summary: Create report
        data:
          viewId: '35130000006450002'
    UserSpecificVariableData:
      type: object
      properties:
        values:
          type: array
          items:
            type: string
        emailIds:
          type: array
          items:
            type: string
            format: email
        defaultValue:
          type: string
        minValue:
          type: string
        maxValue:
          type: string
        stepSize:
          type: string
        domainName:
          type: string
    ReorderColumnsConfig:
      type: object
      properties:
        columns:
          type: array
          items:
            type: string
          description: List of column IDs in the desired order. All available columns in the table should be provided.
      required:
      - columns
      examples:
      - columns:
        - '2531676000011845005'
        - '2531676000011845008'
        - '2531676000011845009'
    MoveViewsToFolderConfig:
      type: object
      properties:
        folderId:
          type: string
          description: ID of the destination folder.
        viewIds:
          type: array
          description: List of view IDs to be moved.
          items:
            type: string
      required:
      - folderId
      - viewIds
      examples:
      - folderId: '176702200001018000'
        viewIds:
        - '1767020000010075002'
        - '1767020000010075004'
    AutoMLWhatIfAnalysisConfig:
      type: object
      properties:
        features:
          type: object
          additionalProperties:
            type: string
            description: Hypothetical value to be used for What-If analysis for the specified feature.
          description: Key-value pairs of feature inputs for What-If analysis. Each key is a feature/column name and each value is the test value used to generate predictions.
      required:
      - features
      examples:
      - features:
          Product: Fruits and Vegetables
          Region: East
          Product Category: Stationery
    AddColumnResponse:
      type: object
      properties:
        status:
          type: string
        summary:
          type: string
        data:
          type: object
          properties:
            columnId:
              type: string
      examples:
      - status: success
        summary: Add column
        data:
          columnId: '1767024000003145017'
    ChangeEmailScheduleStatusConfig:
      type: object
      properties:
        operation:
          type: string
          enum:
          - activate
          - deactivate
          description: To specify the new status for the schedule
      required:
      - operation
      examples:
      - operation: deactivate
    ColumnDesign:
      type: object
      properties:
        COLUMNNAME:
          type: string
          description: Name of the column.
        DATATYPE:
          type: string
          enum:
          - PLAIN
          - MULTILINE
          - EMAIL
          - URL
          - NUMBER
          - POSITIVE_NUMBER
          - DECIMAL_NUMBER
          - CURRENCY
          - PERCENTAGE
          - AUTONUMBER
          - CATEGORY
          - DATE
          - BOOLEAN
          - GEOLOCATION
          description: Datatype of the column.
        MANDATORY:
          type: boolean
          description: Whether the column is mandatory.
        DESCRIPTION:
          type: string
          description: Optional column description.
        DEFAULT:
          type: string
          description: Default value for the column.
        GEOROLE:
          type: integer
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - 6
          - 7
          - 8
          description: Geo role ID applicable for geolocation columns.
        ISHIDE:
          type: boolean
          description: Whether the column is hidden.
        PII:
          type: boolean
          description: Marks the column as containing Personally Identifiable Information.
        LOOKUPCOLUMN:
          $ref: '#/components/schemas/LookupColumnDesign'
          description: Lookup configuration if column is a lookup.
      required:
      - COLUMNNAME
      - DATATYPE
    DeleteFormulaColumnConfig:
      type: object
      properties:
        deleteDependentViews:
          type: boolean
          description: To delete the column along with dependent views. Default is false
      examples:
      - summary: Delete formula with dependent views false
        value:
          deleteDependentViews: false
  parameters:
    model-id:
      name: model-id
      in: path
      required: true
      schema:
        type: string
      description: ID of the AutoML analysis model.
    view-id:
      name: view-id
      in: path
      required: true
      schema:
        type: string
      description: ID of the view.
    org-id:
      name: ZANALYTICS-ORGID
      in: header
      required: true
      schema:
        type: string
      description: Organization ID (can be obtained using Get Organizations API).
    workspace-id:
      name: workspace-id
      in: path
      required: true
      schema:
        type: string
      description: ID of the workspace.
    analysis-id:
      name: analysis-id
      in: path
      required: true
      schema:
        type: string
      description: ID of the AutoML analysis.
    variable-id:
      name: variable-id
      in: path
      required: true
      schema:
        type: string
      description: ID of the variable.
    folder-id:
      name: folder-id
      in: path
      required: true
      schema:
        type: string
      description: ID of the folder.
    column-id:
      name: column-id
      in: path
      required: true
      schema:
        type: string
      description: ID of the column.
    formula-id:
      name: formula-id
      in: path
      required: true
      schema:
        type: string
      description: ID of the formula.
    schedule-id:
      name: schedule-id
      in: path
      required: true
      schema:
        type: string
      description: ID of the email schedule.
    deployment-id:
      name: deployment-id
      in: path
      required: true
      schema:
        type: string
      description: ID of the AutoML analysis deployment.
  securitySchemes:
    iam-oauth2-schema:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.zoho.com/oauth/v2/auth
          tokenUrl: https://accounts.zoho.com/oauth/v2/token
          refreshUrl: https://accounts.zoho.com/oauth/v2/token
          scopes:
            ZohoAnalytics.data.read: Read data from Zoho Analytics.
            ZohoAnalytics.data.delete: Delete data from Zoho Analytics.
            ZohoAnalytics.data.update: Update data in Zoho Analytics.
            ZohoAnalytics.data.create: Create data in Zoho Analytics.
            ZohoAnalytics.data.all: Full access to data in Zoho Analytics.
            ZohoAnalytics.fullaccess.all: Full access to all Zoho Analytics features.