openapi: 3.2.0 info: title: Sigma Computing Workbooks API version: '1.0' description: 'Operations tagged workbooks across 2 of this provider''s published API definitions: sigma-computing-public-rest-api-openapi.json, sigma-computing-rest-api-openapi.yaml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations tags: - name: workbooks paths: /v2/workbooks: get: summary: List workbooks description: "This endpoint retrieves a list of all available workbooks.\n\n Available workbooks include any workbooks in your My Documents folder and any workbooks you have access to.\n\n Users with the Admin account type can optionally retrieve all workbooks in the organization.\n\n ### Usage notes\n This endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit.\n\n #### Pagination\n\n This endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows:\n\n - hasMore: A boolean value indicating whether there are more pages of data available beyond the current page.\n - total: The total number of entries available across all pages.\n - nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data.\n\n #### Example response for pagination\n ```json\n {\n \"hasMore\": true,\n \"total\": 104,\n \"nextPage\": \"50\"\n }\n ```\n\n To request additional pages, include the `nextPage` option in your next request as the value of the `page` option. Repeat this process until `nextPage` returns `null`, indicating that there are no more pages to return.\n\n ### Usage scenarios\n - **Workbook navigation:** Allows users to easily navigate through their collection of workbooks and access the one they need.\n - **Integration points:** Useful for building integrations that need to present users with a list of their available workbooks, such as in custom applications using Sigma Embeds." parameters: - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query - name: excludeTags schema: type: boolean in: query - name: skipPermissionCheck schema: type: boolean description: Only available to Sigma admins. Return all workbooks, including explorations, regardless of whether the user has access. in: query - name: isArchived schema: type: boolean description: Return archived workbooks. in: query - name: excludeExplorations schema: type: boolean description: When used with `skipPermissionCheck`, excludes explorations from the results, otherwise ignored. in: query operationId: listWorkbooks responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: allOf: - type: object required: - workbookId - workbookUrlId - name - url - path - latestVersion - ownerId properties: workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID workbookUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number ownerId: type: string - type: object required: - createdBy - updatedBy - createdAt - updatedAt properties: createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. - type: object properties: isArchived: type: boolean tags: type: array items: type: object required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt properties: versionTagId: type: string description: Unique identifier of the tag. title: Tag ID name: type: string sourceWorkbookVersion: type: number taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. title: Workbook ID workbookTaggedAt: type: string format: date-time description: type: string description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. - type: object properties: total: type: number description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] post: summary: Create a workbook description: 'This endpoint lets you create an empty workbook in Sigma, letting you start a data analysis project or report without any pre-existing templates or data sources set up. ### Usage notes - The `name` parameter is required to provide a name for the new workbook. - Use the **folderId** to specify the folder in which to save the workbook. Retrieve the **folderId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. ### Usage scenarios - **Project initialization**: When starting a new project that requires data analysis or reporting, users can quickly generate a new blank workbook to begin structuring their data and analyses. - **Template preparation**: Administrators or team leads might create blank workbooks to set up standardized templates that their teams can use to maintain consistency in data handling and reporting. ### Best practices - **Naming conventions**: Establish and follow consistent naming conventions for workbooks to make it easier to manage and identify them within larger projects. - **Folder organization**: Use the **folderId** to organize workbooks into relevant folders, which helps in maintaining a tidy workspace, especially in environments with multiple users or teams. - **Access control**: Regularly review and manage access permissions for new workbooks, ensuring that only the appropriate personnel can view or edit sensitive data.' parameters: [] operationId: createWorkbook requestBody: description: The request body. content: application/json: schema: allOf: - type: object required: - folderId - name properties: folderId: type: string description: ID of the folder where the new workbook is created. title: Folder ID name: type: string description: Name of the new workbook. title: Workbook Name - type: object properties: description: type: string description: Description of the workbook. title: Description ownerId: type: string description: ID of the user (member) to own the workbook. title: Owner ID examples: Create a blank workbook: value: folderId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff name: My new blank Workbook description: This is a description ownerId: FFFFFFFFFFFFFFF99999999999999 responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - workbookId - workbookUrlId - name - url - path - latestVersion - ownerId properties: workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID workbookUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number ownerId: type: string - type: object required: - createdBy - updatedBy - createdAt - updatedAt properties: createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. - type: object properties: isArchived: type: boolean tags: type: array items: type: object required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt properties: versionTagId: type: string description: Unique identifier of the tag. title: Tag ID name: type: string sourceWorkbookVersion: type: number taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. title: Workbook ID workbookTaggedAt: type: string format: date-time description: type: string examples: Response Example: value: workbookId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff workbookUrlId: 57a96EMo3GVJG73179MV2l name: My new Workbook url: https://example.com/workbooks/88889999-aaaa-bbbb-cccc-ddddeeeeffff path: folder1 latestVersion: 1 isArchived: false createdAt: '2022-01-01T00:00:00.000Z' createdBy: user1 updatedAt: '2023-01-01T00:00:00.000Z' updatedBy: user2 ownerId: user1 default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}: get: summary: Get a workbook description: 'This endpoint retrieves a workbook by its unique identifier (`workbookId`). It provides detailed information about the workbook, including its name, URL, path, and other metadata. You can use this endpoint to fetch specific workbook details for display or further processing within client applications. ### Usage notes - The **workbookId** parameter must be a valid UUID that uniquely identifies the workbook. Invalid or nonexistent IDs return an error. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. ### Usage scenarios - **Data retrieval**: Developers can use this endpoint to programmatically retrieve details about a specific workbook to display its content or metadata in a custom user interface. - **Integration**: This endpoint is crucial for integrations where other systems need to fetch workbook details based on an ID provided through another interface or workflow. ### Best practices - Validate the **workbookId** on the client side before making a request to avoid unnecessary server load caused by invalid requests.' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: getWorkbook responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - workbookId - workbookUrlId - name - url - path - latestVersion - ownerId properties: workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID workbookUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number ownerId: type: string - type: object required: - createdBy - updatedBy - createdAt - updatedAt properties: createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. - type: object properties: isArchived: type: boolean tags: type: array items: type: object required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt properties: versionTagId: type: string description: Unique identifier of the tag. title: Tag ID name: type: string sourceWorkbookVersion: type: number taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. title: Workbook ID workbookTaggedAt: type: string format: date-time description: type: string examples: Response Example: value: workbookId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff workbookUrlId: 57a96EMo3GVJG73179MV2l name: My workbook url: https://example.com/workbooks/88889999-aaaa-bbbb-cccc-ddddeeeeffff path: folder1 latestVersion: 1 createdAt: '2022-01-01T00:00:00.000Z' createdBy: user1 updatedAt: '2023-01-01T00:00:00.000Z' updatedBy: user2 ownerId: user1 isArchived: false tags: - versionTagId: 11111111-1111-1111-1111-111111111111 name: My tag sourceWorkbookVersion: 1 taggedWorkbookId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff workbookTaggedAt: '2022-02-01T00:00:00.000Z' description: Describe my workbook default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/bookmarks: get: summary: List bookmarks in a workbook description: "Returns a list of available bookmarks in a workbook. Available bookmarks are those that you have created or that have been shared with you.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n### Usage scenarios\n- **Maintenance and governance**: Review workbook bookmarks for usage, validity, and freshness.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: getWorkbookBookmarks responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: allOf: - type: object required: - bookmarkId - name - isShared - exploreKey properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. - type: object properties: isDefault: type: boolean description: Whether the bookmark is default. nextPage: type: - string - 'null' - type: object properties: total: type: number default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] post: summary: Add a bookmark to a workbook description: "Add a bookmark to a workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **workbookVersion** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `latestVersion` in the response for the workbook, or from the version history **More** menu for the specific version.\n- Retrieve the **exploreKey** by identifying the ID of the workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`.\n\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: postWorkbookBookmarks requestBody: description: The request body. content: application/json: schema: type: object required: - workbookVersion - name - isShared - exploreKey properties: workbookVersion: type: number name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - bookmarkId - name - isShared - exploreKey properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. - type: object properties: isDefault: type: boolean description: Whether the bookmark is default. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/bookmarks/{bookmarkId}: get: summary: Get a bookmark description: "Retrieve details of a workbook bookmark.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: bookmarkId schema: type: string in: path required: true operationId: getWorkbookBookmark responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - bookmarkId - name - isShared - exploreKey properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. - type: object properties: isDefault: type: boolean description: Whether the bookmark is default. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] patch: summary: Update a workbook bookmark description: "Update a workbook bookmark, for example by updating the bookmark to use a new exploration of the workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.\n- Retrieve the **exploreKey** by identifying the ID of the workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: bookmarkId schema: type: string in: path required: true operationId: updateWorkbookBookmark requestBody: description: The request body. content: application/json: schema: type: object properties: name: type: - string - 'null' isShared: type: - boolean - 'null' isDefault: type: - boolean - 'null' exploreKey: type: - string - 'null' description: ID of the associated exploration. responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - bookmarkId - name - isShared - exploreKey properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. - type: object properties: isDefault: type: boolean description: Whether the bookmark is default. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] delete: summary: Delete a bookmark from a workbook description: "Delete a bookmark from a workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: bookmarkId schema: type: string in: path required: true operationId: deleteWorkbookBookmarks responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/columns: get: summary: List columns for all elements in a workbook description: "This endpoint retrieves all columns in a workbook for all element in the workbook.\n\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n ### Usage scenarios\n - **Data exploration:** Enable users to explore the data structure of a workbook element, facilitating deeper analysis and understanding.\n - **Integration tasks:** Useful for developers integrating Sigma with other tools that need to know the data structure to map data accurately.\n\n ### Best practices\n - Use this endpoint when setting up interfaces that require specific knowledge about the data structure." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: getWorkbookColumns responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: type: object required: - columnId - name - formula - type - elementId properties: columnId: type: string description: Column ID name: type: string description: Column name formula: type: string description: Column formula or source column reference. type: type: object description: The column's data type, represented as a recursive type object. elementId: type: string description: Element ID nextPage: type: - string - 'null' - type: object properties: total: type: number examples: Response Example: value: entries: - columnId: cWoHPEQoiG label: City formula: '[STATIONS/City]' elementId: 4eJb2QhzOm - columnId: RyThlKefu label: Dock Count formula: '[STATIONS/Dock Count]' elementId: 4eJb2QhzOm - columnId: ffARyThlK label: Name formula: '[STATIONS/Name]' elementId: 4eJb2QhzOm nextPage: null default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/controls: get: summary: List workbook controls description: 'This endpoint retrieves all controls associated with a specific workbook. Controls are interactive elements like checkboxes, or dropdowns used within the workbook for dynamic data interaction. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. ### Usage scenarios - **Dynamic data interaction:** Allows users to interact dynamically with the data presented in the workbook through various control mechanisms. - **Custom reporting:** Enables the creation of customizable reports where end users can adjust parameters to filter and sort data according to their requirements. ### Best practices - Ensure proper access controls are set to manage who can view or interact with the controls to prevent unauthorized data manipulation. - Use detailed and descriptive names for controls to facilitate easier identification and use by end users.' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: getWorkbookControls responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: type: object required: - name - valueType properties: name: type: string valueType: oneOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - text - type: string enum: - date - type: string enum: - number-list - type: string enum: - text-list - type: string enum: - date-list - type: string enum: - boolean-list - type: string enum: - date-range - type: string enum: - number-range - type: string enum: - date-null - type: string enum: - number-null - type: string enum: - text-null - type: string enum: - boolean-null description: Value of the control nextPage: type: - string - 'null' - type: object properties: total: type: number default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/convertToReport: post: summary: Convert a workbook to a report description: "This endpoint converts an existing workbook into a new report. When you convert a workbook, the existing workbook is not modified. Elements and functionality in the workbook that are not supported in reports are listed in a `warnings` array in the response. Unsupported workbook contents are either removed (not added to the new report) or, if supported contents depend on them, are added to a hidden page at the end of the report.\n See [Limitations and unsupported elements](https://help.sigmacomputing.com/docs/convert-workbooks-to-reports#limitations-and-unsupported-elements).\n\n You can also convert a workbook to a report from the UI. See [Convert workbooks to reports](https://help.sigmacomputing.com/docs/convert-workbooks-to-reports).\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- The **name** parameter is required.\n- Use **destinationFolderId** to choose where to save the report. If not provided, the report is saved to your **My Documents** folder.\n- Use **pageIds** to convert only specific workbook pages. If not provided, the entire workbook is converted.\n- Use **format** to set the page size and orientation. The default size is letter, and the default orientation is portrait." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: convertWorkbookToReport requestBody: description: The request body. content: application/json: schema: allOf: - type: object required: - name properties: name: type: string description: Name for the new report. title: Report name - type: object properties: destinationFolderId: type: string description: ID of the folder in which to create the new report. Defaults to your "My Documents" folder. title: Destination Folder ID description: type: string description: A description for the new report. title: Description pageIds: type: array items: type: string description: IDs of the workbook pages to convert. Defaults to the entire workbook. title: Page IDs format: oneOf: - allOf: - type: object required: - pageSize properties: pageSize: type: string enum: - letter - a4 - legal - a3 description: A standard page-size preset. title: Page size - type: object properties: layout: type: string enum: - portrait - landscape description: Page orientation. Defaults to `portrait`. title: Layout description: A standard page-size preset (letter, a4, legal, or a3). title: Preset format - type: object required: - pageSize - unit - width - height properties: pageSize: type: string enum: - custom description: Use a custom page size. title: Custom page size unit: type: string enum: - pixels - inches - centimeters description: Unit for the `width` and `height` values. title: Unit width: type: number description: Page width, in the given unit. title: Width height: type: number description: Page height, in the given unit. title: Height description: A custom page size, in pixels, inches, or centimeters. title: Custom format description: Page size and orientation for the report. Defaults to letter portrait. title: Format description: Body parameters for converting a workbook to a report. responses: '201': description: The response body. content: application/json: schema: type: object required: - convertedReport - sourceWorkbook - warnings properties: convertedReport: allOf: - type: object required: - reportId - reportUrlId - name - url - path - latestVersion - ownerId properties: reportId: type: string description: Unique identifier of the report. title: Report ID reportUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number ownerId: type: string - type: object required: - createdBy - updatedBy - createdAt - updatedAt properties: createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. - type: object properties: isArchived: type: boolean tags: type: array items: allOf: - type: object required: - versionTagId - tagName - sourceVersion - taggedAt properties: versionTagId: type: string description: Unique identifier of the tag. title: Tag ID tagName: type: string sourceVersion: type: number taggedAt: type: string format: date-time - type: object required: - taggedReportId properties: taggedReportId: type: string description: Unique identifier of the tagged report. title: Report ID description: type: string sourceWorkbook: type: object required: - workbookId - name - url properties: workbookId: type: string description: Unique identifier of the source workbook. title: Workbook ID name: type: string description: Name of the source workbook. title: Workbook name url: type: string description: URL of the source workbook. title: Workbook URL warnings: type: array items: allOf: - type: object required: - code - message properties: code: type: string description: Machine-readable warning code, in kebab-case. Treat this as an open set and handle unknown codes gracefully. title: Code message: type: string description: Human-readable explanation of the warning. title: Message - type: object properties: details: type: array items: allOf: - type: object required: - type - count properties: type: type: string description: Element type, in kebab-case. title: Type count: type: number description: Number of affected elements of this type. title: Count - type: object properties: sourceElementIds: type: array items: type: string description: IDs of the affected elements in the source workbook. title: Source element IDs reportElementIds: type: array items: type: string description: IDs of the affected elements in the new report. title: Report element IDs parent: type: object required: - type - id properties: type: type: string description: Unsupported parent type, in kebab-case (e.g. `sidebar-panel`, `repeater`, `modal`). title: Parent type id: type: string description: ID of the unsupported parent in the source workbook. title: Parent ID description: The unsupported parent that caused this element to drop, if applicable. title: Parent description: Per-element details for this warning, when available. title: Details description: Warnings about content that could not be carried over to the report. May be empty. title: Warnings default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/copy: post: summary: Duplicate a workbook description: "This endpoint lets you duplicate an existing workbook. The workbook copy can be placed in a different folder from the original workbook, potentially with a different name and description. This is useful for creating workbook templates or backups.\n\n### Usage notes\n- The `workbookId` in the URL specifies the original workbook to be copied. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- The `destinationFolderId` in the request body specifies where to place the new workbook.\n\n - To use the \"My Documents\" folder for a specific user as the destination folder, call the [/v2/members/{memberId}](https://help.sigmacomputing.com/reference/get-member) endpoint and use the `homeFolderId` included in the response.\n - Retrieve the **folderId** of all folders by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.\n\n### Usage scenarios\n- **Reuse**: Use an existing workbook as a baseline for a \"one-off\" purpose instead of a template.\n- **Template creation**: Create a copy of a workbook to serve as a template for future projects.\n- **Backup**: Make a backup of a workbook before making significant changes. [Version tagging](https://help.sigmacomputing.com/docs/version-tagging) is also a useful way to accomplish this.\n\n### Best practices\n- Always verify that the destination folder has the correct permissions set to avoid access issues.\n- When using as a template, ensure that all data connections are correctly configured to prevent data leaks or errors.\n\n### Copying bookmarks\n- Set `copyBookmarks` to `all` to copy every saved view (formerly \"bookmarks\") applied to the source workbook. This is available to admins only.\n- Set `copyBookmarks` to `accessible` to copy personal saved views and those shared with the user initiating the operation.\n- Ownership of all copied bookmarks transfers to the user initiating the copy operation." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: copyWorkbook requestBody: description: The request body. content: application/json: schema: allOf: - type: object required: - destinationFolderId - name properties: destinationFolderId: type: string description: ID of the folder in which to place the copied workbook. title: Destination Folder ID name: type: string description: Name for the copied workbook as it appears in Sigma. title: New Workbook Name - type: object properties: description: type: string description: A description for the new workbook. title: New Description copyBookmarks: type: string enum: - all - accessible description: If set to `all` (available to admins only), every saved view (bookmark) applied to the workbook is copied. If set to `accessible`, only personal saved views and those shared with the user initiating the operation are copied. Ownership of all saved views in the duplicate workbook transfers to the user initiating the operation. If not set, saved views are not copied. title: Copy Bookmarks description: Body parameters for copying a workbook. responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - workbookId - workbookUrlId - name - url - path - latestVersion - ownerId properties: workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID workbookUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number ownerId: type: string - type: object required: - createdBy - updatedBy - createdAt - updatedAt properties: createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. - type: object properties: isArchived: type: boolean tags: type: array items: type: object required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt properties: versionTagId: type: string description: Unique identifier of the tag. title: Tag ID name: type: string sourceWorkbookVersion: type: number taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. title: Workbook ID workbookTaggedAt: type: string format: date-time description: type: string default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/elements: get: summary: List elements in a workbook description: 'This endpoint retrieves all elements in a workbook, which lets you understand and interact with the individual components that make up the workbook, such as charts, tables, or controls. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - To retrieve elements from version-tagged workbooks, pass the `tagName` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `tags.name` included in the response for a given workbook. - To retrieve elements from a bookmark (saved view), pass the `bookmarkId` in the query parameters. Retrieve the bookmarkId by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) or [/v2/workbooks/{workbookId}/tags/:tagName/bookmarks](https://help.sigmacomputing.com/reference/get-tagged-workbook-bookmarks) endpoints. ### Usage scenarios - **Detailed analysis:** Developers and users can retrieve specific elements for detailed data analysis or further manipulation. - **Interface customization:** Allows for dynamic interface construction where users can choose which elements to display or interact with. ### Best practices - Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience. - Validate both the workbookId and pageId to ensure they correspond to valid, accessible resources before making API calls.' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query - name: tagName schema: type: string in: query - name: bookmarkId schema: type: string description: Unique identifier of the bookmark. title: Bookmark ID in: query operationId: listWorkbookElements responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: allOf: - type: object required: - elementId properties: elementId: type: string - type: object properties: name: type: string type: type: string columns: type: array items: type: string vizualizationType: type: string error: type: string nextPage: type: - string - 'null' - type: object properties: total: type: number default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/elements/{elementId}/columns: get: summary: List columns for a workbook element description: "This endpoint retrieves a list of columns associated with a specific element within a workbook. It provides metadata about each column, such as name and formula, which can be essential for understanding the data structure and for further data manipulation or analysis.\n\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint.\n\n ### Usage scenarios\n - **Data exploration:** Helps users to explore the data structure of a workbook element, facilitating deeper analysis and understanding.\n - **Integration tasks:** Useful for developers integrating Sigma with other tools, needing to know the data structure to map data accurately.\n\n ### Best practices\n - Validate the elementId to make sure it corresponds to the correct workbook element before querying.\n - Leverage this endpoint when setting up interfaces that require specific knowledge about the data structure." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: elementId schema: type: string description: Unique identifier of the workbook element. title: Element ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: getElementColumns responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: type: object required: - columnId - label - formula - type properties: columnId: type: string description: Column ID label: type: string description: Column name formula: type: string description: Column formula type: type: object description: The column's data type, represented as a recursive type object. nextPage: type: - string - 'null' - type: object properties: total: type: number default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/elements/{elementId}/materializationSchedules: post: summary: Create a materialization schedule for a workbook element (Beta) description: "This endpoint creates a materialization schedule for an element in a workbook. The scheduled run materializes the element's data on the given cadence, allowing the data to be stored or cached for optimized access and performance.\n\n For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).\n\n **Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - Retrieve the **elementId** by calling the [/v2/workbooks/{workbookId}/elements](https://help.sigmacomputing.com/reference/list-workbook-elements) endpoint.\n - [Write access](https://help.sigmacomputing.com/docs/set-up-write-access) must be enabled on your connection.\n - To perform this operation, you must use API credentials owned by a user assigned to an account type with the **Schedule materializations** permission.\n - An element can have at most one materialization schedule.\n - The materialization run starts immediately upon creation using the latest published version of the workbook." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: elementId schema: type: string description: Identifier of the workbook element to materialize on a schedule. Must be an element, such as a table or visualization, that can be materialized. title: Element ID in: path required: true operationId: createMaterializationSchedule requestBody: description: The request body. content: application/json: schema: type: object required: - schedule properties: schedule: allOf: - type: object required: - cronSpec properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. - type: object properties: timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. Defaults to the organization timezone. description: When to run the materialization. title: Schedule responses: '201': description: The response body. content: application/json: schema: type: object required: - sheetId - elementId - elementName - schedule - configuredAt - paused properties: sheetId: type: string description: Identifier of the materialization schedule for the element title: Sheet ID elementId: type: string description: Identifier of the element being materialized title: Element ID elementName: type: string schedule: type: - object - 'null' properties: cronSpec: type: string description: Cron expression to use for the schedule timezone: type: string description: Timezone code, for example, PST configuredAt: type: string format: date-time paused: type: boolean default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] patch: summary: Update a materialization schedule for a workbook element (Beta) description: "This endpoint updates the schedule cadence and/or timezone of an existing materialization schedule for an element in a workbook.\n For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).\n\n **Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - Retrieve the **elementId** by calling the [/v2/workbooks/{workbookId}/elements](https://help.sigmacomputing.com/reference/list-workbook-elements) endpoint.\n - [Write access](https://help.sigmacomputing.com/docs/set-up-write-access) must be enabled on your connection.\n - To perform this operation, you must use API credentials owned by a user assigned to an account type with the **Schedule materializations** permission.\n - The workbook element must already have a materialization schedule. To create one, call the [/v2/dataModels/{dataModelId}/elements/{elementId}/materializationSchedules](https://help.sigmacomputing.com/reference/create-materialization-schedule) endpoint." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: elementId schema: type: string description: Identifier of the workbook element to materialize on a schedule. Must be an element, such as a table or visualization, that can be materialized. title: Element ID in: path required: true operationId: patchMaterializationSchedule requestBody: description: The request body. content: application/json: schema: type: object required: - schedule properties: schedule: allOf: - type: object required: - cronSpec properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. - type: object properties: timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. Defaults to the organization timezone. description: When to run the materialization. title: Schedule responses: '200': description: The response body. content: application/json: schema: type: object required: - sheetId - elementId - elementName - schedule - configuredAt - paused properties: sheetId: type: string description: Identifier of the materialization schedule for the element title: Sheet ID elementId: type: string description: Identifier of the element being materialized title: Element ID elementName: type: string schedule: type: - object - 'null' properties: cronSpec: type: string description: Cron expression to use for the schedule timezone: type: string description: Timezone code, for example, PST configuredAt: type: string format: date-time paused: type: boolean default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] delete: summary: Delete a materialization schedule for a workbook element (Beta) description: "This endpoint deletes the materialization schedule for an element in a workbook. Any subsequent scheduled materialization runs for the element are cancelled.\n For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).\n\n **Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.\n\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - Retrieve the **elementId** by calling the [/v2/workbooks/{workbookId}/elements](https://help.sigmacomputing.com/reference/list-workbook-elements) endpoint.\n - [Write access](https://help.sigmacomputing.com/docs/set-up-write-access) must be enabled on your connection.\n - To perform this operation, you must use API credentials owned by a user assigned to an account type with the **Schedule materializations** permission.\n - The workbook element must already have a materialization schedule." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: elementId schema: type: string description: Identifier of the workbook element to materialize on a schedule. Must be an element, such as a table or visualization, that can be materialized. title: Element ID in: path required: true operationId: deleteMaterializationSchedule responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/elements/{elementId}/query: get: summary: Get the SQL query for a workbook element description: 'This endpoint retrieves the SQL query associated with a specific element in a workbook. It allows users to view and understand how the data for that element is being processed and transformed, which is critical for debugging, optimization, and educational purposes. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve the **elementId** for a custom SQL element by calling the [/v2/workbooks/{workbookId}/queries](https://help.sigmacomputing.com/reference/list-workbook-queries) endpoint. - To retrieve the query for an element from a version-tagged workbook, pass the `tagName` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `tags.name` included in the response for a given workbook. - To retrieve the query for an element from a bookmark (saved view), pass the `bookmarkId` in the query parameters. Retrieve the bookmarkId by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) or [/v2/workbooks/{workbookId}/tags/:tagName/bookmarks](https://help.sigmacomputing.com/reference/get-tagged-workbook-bookmarks) endpoints. ### Usage scenarios - **Development and debugging:** Provides developers and analysts with the ability to retrieve and review the SQL code behind workbook elements, facilitating troubleshooting and enhancements. - **Educational insight:** Useful for training purposes or for users learning to understand the impact of various transformations and filters applied within their Sigma workbooks. ### Best practices - Ensure proper access controls are in place to manage who can view potentially sensitive query information. - Use this endpoint as part of a regular review process to ensure that all queries are optimized and up to date with current data schemas.' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: elementId schema: type: string description: Unique identifier of the workbook element. title: Element ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query - name: tagName schema: type: string in: query - name: bookmarkId schema: type: string in: query operationId: getElementQuery responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - elementId properties: elementId: type: string - type: object properties: name: type: string sql: type: string error: type: string default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/embeds: get: summary: Get embeds for a workbook description: 'This endpoint retrieves the list of available embeds for a specific workbook. The response provides the embedUrl and indicates whether an embed is public. ### Usage notes - The endpoint requires the `workbookId` as a path parameter to identify the workbook. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. ### Usage scenarios - **Integration with third-party applications:** Developers can use this endpoint to list embeds that integrate workbook content into third-party applications, enhancing functionality or providing customized views. - **Internal dashboards:** Teams within an organization can embed workbook content into internal dashboards to monitor real-time data and analytics from various workbooks without directly accessing Sigma. ### Best practices - Ensure that the embeds are used in compliance with data governance and privacy policies. - Regularly review and manage the access permissions for each embed to prevent unauthorized data exposure.' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: listWorkbookEmbeds responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: type: object required: - embedId - embedUrl - public - sourceType - sourceId - sourceName properties: embedId: type: string description: Unique identifier of the embed. title: Embed ID embedUrl: type: string public: type: boolean sourceType: type: string enum: - workbook - page - element sourceId: type: - string - 'null' sourceName: type: - string - 'null' description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. - type: object properties: total: type: number description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] post: summary: Create an embed for a workbook description: "This endpoint lets you create an embed for a specific workbook. You can embed an entire workbook, a specific page, or an individual element within a workbook. Embedding enables seamless integration of Sigma content into other applications, websites, or internal platforms, providing a flexible and dynamic way to present and interact with data.\n\n### Embedding options\n\n- Publicly embed Sigma in a public website by creating an embed of type `public`.\n- Securely embed Sigma in an authenticated host application.\n\n - (Recommended) Use JSON Web Tokens (JWT) to sign the workbook URL outputted by the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint instead of the output of this endpoint. See [Create a secure embed](/docs/create-a-secure-embed).\n - (Deprecated) Use this endpoint to create an embed of type `secure`. This option is deprecated. See [Migrate to JWT-signed secure embed URLs](/docs/migrate-to-jwt-signed-secure-embed-urls).\n\n### Usage notes\n- The endpoint requires the workbookId as a path parameter. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- The body of the request must specify the type of embed (public).\n- You must specify the source type (workbook, page, element) and ID for that source to create the embed.\n\n - Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint.\n - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint.\n\n### Usage scenarios\n- **Web application integration:** Developers can use this API to generate the embed URL for integration into their application or for display on a public-facing webpage.\n\n### Best practices\n- Validate the `workbookId` and `sourceId` to ensure they refer to existing resources before attempting to create an embed.\n- Consider the security settings of the embed type to match the integration context, ensuring that data exposure is controlled and appropriate for the audience." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: createWorkbookEmbed requestBody: description: The request body. content: application/json: schema: allOf: - type: object required: - embedType - sourceType properties: embedType: type: string enum: - public description: Defines the visibility and access control of the embed. Choose `public` for open access. title: Embed Type sourceType: type: string enum: - workbook - page - element description: 'Specifies the scope of the embed: "workbook" for the entire workbook, "page" for a single page, or "element" for a specific element within the workbook.' title: Source Type - type: object properties: sourceId: type: string description: The specific identifier for the page or element to be embedded if the sourceType is "page" or "element". title: Source ID responses: '200': description: The response body. content: application/json: schema: type: object required: - embedId - embedUrl properties: embedId: type: string description: Unique identifier of the embed. title: Embed ID embedUrl: type: string default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/embeds/{embedId}: delete: summary: Delete an embed from a workbook description: "This endpoint lets you delete an embed associated with a specific workbook. It is useful for cleaning up unnecessary or outdated embeds to maintain a streamlined environment.\n\n ### Usage Notes\n - Requires `workbookId` and `embedId` as path parameters to specify which embed to delete.\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - Retrieve the **embedId** by calling the [/v2/workbooks/{workbookId}/embeds](https://help.sigmacomputing.com/reference/list-workbook-embeds) endpoint.\n\n ### Usage Scenarios\n - **Maintenance**: Regularly remove unused or expired embeds to keep your Sigma environment clean and efficient.\n\n ### Best Practices\n - Confirm the usage and necessity of an embed before deletion to avoid disrupting dependent services or applications." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: embedId schema: type: string description: Unique identifier of the embed. title: Embed ID in: path required: true operationId: deleteWorkbookEmbeds responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/export: post: summary: Export data from a workbook description: 'This endpoint lets you create a file containing data exported from a workbook, allowing you to retrieve large sets of data in a structured format. Export the entire workbook, a single workbook page, or an individual element. You can specify parameters to filter the data and format options for the file. Different file formats, including CSV, PDF, JSON, and others, are supported for different export choices. See [Send or schedule workbook exports](/docs/send-or-schedule-workbook-exports) for details on supported formats for different types of exports. Successful requests to the endpoint return a queryId. Use the **queryId** with the [/v2/query/{queryId}/download](https://help.sigmacomputing.com/reference/download-query) endpoint to download the requested file when it is ready. See [Download an exported file](https://help.sigmacomputing.com/reference/download-query). ## Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - This endpoint is rate limited to 400 requests per minute. - This endpoint exports up to 1 million rows for CSV/XLSX/JSON file formats. You can export more rows if you batch your requests in chunks of up to 1 million rows. Use the `rowLimit` parameter to specify the size of the chunk and the `offset` parameter to specify the row to start the next chunk from. For example, if you specify a rowLimit of 2500, to export the next chunk of 2500 rows, specify an offset of 2501. The order of the data matches the order in the data element when the request is made, so there is a possibility of data overlap between requests. - For security and privacy reasons, the `queryId` used to download the exported data expires 1 hour after your request is received and the file becomes available to download. You can extend this default expiration to 6 hours using the `resultsValidityTimeMs` request parameter. - When exporting a PNG file, the `pixelWidth` and `pixelHeight` parameters are respected on a best effort basis and the output might not match the requested dimensions. ## Usage scenarios - Conditional workbook export: Based on an external set of conditions, export a workbook from Sigma. - Data analysis: Export specific sets of data for offline analysis, leveraging tools that might not connect directly to a data warehouse. - Integration: Integrate enriched and analyzed data with other applications, providing the necessary data in a format that these applications can process. ## Best practices - Clearly specify parameters to retrieve only the necessary data, optimizing performance and reducing network load.' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: exportWorkbook requestBody: description: The request body. content: application/json: schema: allOf: - oneOf: - type: object required: - elementId - format properties: elementId: type: string format: oneOf: - type: object required: - type properties: type: type: string enum: - csv - jsonl - json - xlsx description: Export options for csv, json, jsonl, xlsx title: Export options for csv, json, jsonl, xlsx - type: object required: - type - layout properties: type: type: string enum: - pdf layout: type: string enum: - portrait - landscape description: Export options for PDF title: Export options for PDF - allOf: - type: object required: - type properties: type: type: string enum: - png - type: object properties: pixelWidth: type: number pixelHeight: type: number description: Export options for PNG title: Export options for PNG description: Export a specific element title: Export element - type: object required: - pageId - format properties: pageId: type: string description: Identifier of the workbook page. format: oneOf: - type: object required: - type - layout properties: type: type: string enum: - pdf layout: type: string enum: - portrait - landscape description: Export options for PDF documents title: Export options for PDF documents - allOf: - type: object required: - type properties: type: type: string enum: - png - type: object properties: pixelWidth: type: number pixelHeight: type: number description: Export options for PNG documents title: Export options for PNG documents - type: object required: - type properties: type: type: string enum: - xlsx description: Export options for EXCEL documents title: Export options for EXCEL documents description: Export a page of a workbook title: Export a page of a workbook - type: object required: - format properties: format: oneOf: - type: object required: - type - layout properties: type: type: string enum: - pdf layout: type: string enum: - portrait - landscape description: Export options for PDF documents title: Export options for PDF documents - type: object required: - type properties: type: type: string enum: - xlsx description: Export options for EXCEL documents title: Export options for EXCEL documents description: Export an entire workbook title: Export an entire workbook - type: object properties: parameters: type: object additionalProperties: type: string description: "Specify the control ID and control value of one or more control elements in the workbook or report to filter the returned data. The control must exist in the Sigma workbook or report and target an element before you can export based on the control value.\n\n**Syntax**\n{ control-id: control-value }\n\nThe control-id is configured in the Sigma workbook or report. The control-value is the value that is passed to the control.\n\nValues can take multiple forms, depending on the data type of the control:\n\n**Boolean**\n\n- Single value: \"true\" | \"false\" | \":null\"\n- List of Boolean: \"true,false,:null\" (No space after the comma.)\n\n**Number**\n\n- Single value: \"10.54\", \":null\"\n- List of values: \"10.54,23.45,:null\" (No space after the comma.)\n- Range of numbers: \"min:10.54,max:23.45\" (No space after the comma or colon.)\n\n**Text**\n\n- Single value: \"some-text\" | \":null\" | \":empty\"\n- List of values: \"some-text,more-text,:null,:empty\" (No space after the comma.)\n\n**Date**\n\nAll dates use UTC time zones.\n\n- Fixed date using ISO-6801 format: \"2022-01-01T01:01:59\" | \":null\"\n - Formats supported (where: %Y: year, %m: month, %d: day, %H:hours, %M: minutes, %S: seconds):\n - %Y-%m-%d\n - %Y-%m-%dT%H:%M\n - %Y-%m-%dT%H:%M:%S\n- List of fixed dates: \"2022-01-01T01:01:59,2022-02-02T02:02:59,:null\"\n- Relative date: \"prior-day-3\" | \"next-day-3\"\n - Format: [prior|next]-[year|quarter|month|week|isoWeek|day|hour|minute]-[number]\n- Date range: \"min:2022-01-01T01:01:59,max:next-day-3\" (No spaces after the comma or colon.)\n - Leave max blank for \"on or after\" and min blank for \"on or before\", for example:\n - \"Date-Range\": \"min:2020-04-01,max:\"\n - \"Date-Range\": \"min:,max:next-day-3\"\n\n**Notes**\n\n- \":null\" is a special value that denotes the null primitive value.\n- \":empty\" is a special value that denotes the empty string \"\".\n\nUse [URL encoding](https://help.sigmacomputing.com/docs/special-characters-for-url-parameters) to encode characters in your control values (such as commas) to prevent the system from interpreting them as separators.\n\nFor example:\n\"New York, NY,Boston, MA\" can be encoded as:\n\n\"New%20York%2C%20NY,Boston%2C%20MA\"" timeout: type: number description: '' tag: type: string description: Specifies the version tag of the workbook to be exported. exportAs: type: string description: Specifies the user ID of the Sigma user to run the export queries as, such as to enforce row-level security. Not supported for users who access Sigma with OAuth. rowLimit: type: number description: 'Total number of rows to limit a CSV/XLSX/JSON-formatted export to. ' offset: type: number description: 'The offset number of rows for a CSV/XLSX/JSON-formatted export to start from. ' examples: Request Example: value: elementId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff format: type: csv timeout: 5 tag: my-tag exportAs: myUserId parameters: param: value filters: filter: value rowLimit: 1000 offset: 0 responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - jobComplete - queryId properties: jobComplete: type: boolean queryId: type: string - type: object properties: rows: type: array items: type: object additionalProperties: {} message: type: string examples: Export Success: value: jobComplete: false rows: '[Array]' queryId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff Export Failure: value: jobComplete: false message: Export finished at 1600000000000 queryId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff Export Incomplete: value: jobComplete: false queryId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/grants: post: summary: Grant permissions on a workbook to users or teams description: "You can use this endpoint to grant specific document permissions on a specific workbook to users or teams.\n\n ### Usage notes\n\n - Ensure the **workbookId** in the path is valid and that the user has rights to modify its permissions. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - Do not set both **memberId** and **teamId** in the same **grantee** object. Instead, choose one based on the target of the grant.\n\n - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n - Retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n - Grant permissions on a specific version tag of a workbook by specifying the **tagId**. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response.\n\n ### Usage scenarios\n\n - **Team collaboration**: Granting edit permissions to a team for collaborative work on a project.\n - **External consultant**: Providing view access to an external consultant.\n\n ### Best practices\n\n - Validate user and team IDs before submitting them in a request to avoid errors.\n - Use the **tagId** to help manage and revoke grants systematically as project requirements change." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: createWorkbookGrant requestBody: description: The request body. content: application/json: schema: type: object required: - grants properties: grants: type: array items: allOf: - type: object required: - grantee - permission properties: grantee: oneOf: - type: object required: - memberId properties: memberId: type: string description: The UUID of the member receiving the grant title: Member - type: object required: - teamId properties: teamId: type: string description: The UUID of the team receiving the grant title: Team permission: type: string enum: - view - explore - edit description: Permission to grant for access to the workbook. title: WorkbookPermission - type: object properties: tagId: type: string title: Workbook grant creation request responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/grants/{grantId}: delete: summary: Delete a workbook grant description: "This endpoint deletes a specific grant from a workbook. Deleting a grant revokes the permissions associated with it, ensuring that the specified users or teams no longer have the access rights previously granted.\n\n ### Usage notes\n - **workbookId:** The identifier of the workbook from which the grant is to be deleted. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - **grantId:** The identifier of the grant that needs to be removed. Retrieve the **grantId** by calling the [/v2/grants](https://help.sigmacomputing.com/reference/list-grants) endpoint with the `workbookId` as the `inodeId`.\n\n ### Usage scenarios\n - **Access revocation:** Administrators can use this endpoint to manage and revoke access as team roles or project needs evolve.\n - **Security compliance:** Ensures that access to sensitive data within workbooks is tightly controlled and can be promptly adjusted in response to security policy changes or personnel updates.\n\n ### Best practices\n - Always confirm the identities associated with both the workbook and grant before proceeding with deletion to avoid accidental revocations.\n - Log and audit all grant deletions to maintain records for security audits and compliance tracking." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: grantId schema: type: string description: Unique identifier of the grant. title: Grant ID in: path required: true operationId: deleteWorkbookGrant responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/lineage: get: summary: List lineage for a workbook description: "This endpoint lists the elements, data sources, and upstream lineage for those data sources in a workbook, providing a detailed view of how data is interconnected within a workbook.\n\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n ### Usage scenarios\n - **Data governance:** Allows data managers to track how information is used and propagated through different workbook elements.\n - **Debugging and optimization:** Helps with identifying and resolving issues in data processing or workbook structure.\n - **Data source management**: Identify the dependencies of data sources in use in a specific workbook.\n\n ### Best practices\n - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams.\n - Use this endpoint to regularly audit workbook structures, ensuring that all data connections and transformations are correct and optimized." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: listLineageTree responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - type: object required: - sourceIds - elementId - dataSourceIds properties: sourceIds: type: - array - 'null' items: type: string description: List of direct sources for the element. Either element IDs or data source IDs. elementId: type: string description: Unique identifier of the element dataSourceIds: type: - array - 'null' items: type: string description: List of root sources for the element as data source IDs. description: '' title: Element details - allOf: - allOf: - type: object required: - type properties: type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - type: object required: - connectionId - name properties: connectionId: type: - string - 'null' name: type: - string - 'null' - type: object required: - dataModelId properties: dataModelId: type: string description: '' title: Source data model details - allOf: - allOf: - type: object required: - type properties: type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - type: object required: - connectionId - name properties: connectionId: type: - string - 'null' name: type: - string - 'null' - type: object required: - inodeId properties: inodeId: type: string description: '' title: Source table or dataset (deprecated) details - allOf: - allOf: - type: object required: - type properties: type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - type: object required: - connectionId - name properties: connectionId: type: - string - 'null' name: type: - string - 'null' - type: object required: - definition properties: definition: type: string description: '' title: Custom SQL definition description: '' title: Source custom SQL details - allOf: - allOf: - type: object required: - type properties: type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - type: object required: - connectionId - name properties: connectionId: type: - string - 'null' name: type: - string - 'null' - type: object required: - csvId properties: csvId: type: string description: Unique identifier of the uploaded CSV file title: CSV ID description: '' title: Source CSV upload details - allOf: - allOf: - type: object required: - type properties: type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - type: object required: - connectionId - name properties: connectionId: type: - string - 'null' name: type: - string - 'null' - type: object required: - semanticViewId - semanticViewTable properties: semanticViewId: type: string description: Unique identifier of the semantic view title: Semantic view ID semanticViewTable: type: string description: Name of the table within the semantic view title: Semantic view table description: '' title: Source semantic view details - allOf: - allOf: - type: object required: - type properties: type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - type: object required: - connectionId - name properties: connectionId: type: - string - 'null' name: type: - string - 'null' - type: object required: - sqlDocumentId properties: sqlDocumentId: type: string description: '' title: Source SQL document details (deprecated) nextPage: type: - string - 'null' - type: object properties: total: type: number examples: Response Example: value: entries: - type: element elementId: 5AbJJlOiPPtgpL3cCk7GqA sourceIds: - QzcnTZrK9y8TjZs0T6OKO dataSourceIds: - QzcnTZrK9y8TjZs0T6OKO/En4r45kOFn - type: element elementId: 5AbJJlOiPPtgpL3cCk7GqA sourceIds: - 4ZJD7G8AR03qf2oySPwoc3 dataSourceIds: - QzcnTZrK9y8TjZs0T6OKO/En4r45kOFn - type: element elementId: 3fqWi0z9SWwxuilnuq8w34 sourceIds: - 2MLjb1f67ldr3FMNI2L6Pf - 4ZJD7G8AR03qf2oySPwoc3 dataSourceIds: - QzcnTZrK9y8TjZs0T6OKO/En4r45kOFn - d5a56ed4-16bf-4de3-be32-e0738f31be42 - datasourceId: QzcnTZrK9y8TjZs0T6OKO/En4r45kOFn connectionId: dd76be0a-08bc-4c88-8a79-9956f933e701 type: data-model dataModelId: d5a56ed4-16bf-4de3-be32-e0738f31be42 - datasourceId: d5a56ed4-16bf-4de3-be32-e0738f31be42 connectionId: dd76be0a-08bc-4c88-8a79-9956f933e701 type: table inodeId: eef50bc2-16c5-44ee-a913-9ae9d95e5295 inodeName: DOCKS nextPage: null default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/lineage/elements/{elementId}: get: summary: List lineage of a workbook element description: "This endpoint retrieves the lineage and dependencies of a specific workbook element. It provides a detailed view of how data is interconnected within a workbook, which can be critical for understanding data sources and dependencies.\n\n ### Usage notes\n - **workbookId:** The UUID of the workbook containing the element. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - **elementId:** The UUID of the element within the workbook whose lineage is being queried. Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint.\n - The element that you request must be a data element, such as a table, pivot table, or visualization. Requesting a UI or control element returns an error.\n\n ### Usage scenarios\n - **Data governance:** Allows data managers to track how information is used and propagated through different workbook elements.\n - **Debugging and optimization:** Helps in identifying and resolving issues in data processing or in the structure of workbook setups.\n - **Data source management**: Identify the data sources in use in a specific workbook.\n\n ### Best practices\n - Use this endpoint to regularly audit workbook structures, ensuring that all data connections and transformations are correct and optimized.\n - Integrate this information into documentation or data dictionaries to enhance transparency and understanding across teams." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: elementId schema: type: string description: Unique identifier of the element in: path required: true operationId: listLineage responses: '200': description: The response body. content: application/json: schema: type: object required: - dependencies - edges properties: dependencies: type: object additionalProperties: oneOf: - type: object required: - nodeId - type properties: nodeId: type: string type: type: string description: '' title: Element details - allOf: - type: object required: - nodeId - type properties: nodeId: type: string type: type: string - type: object required: - name - elementId properties: name: type: string elementId: type: string description: '' title: Sheet details - allOf: - type: object required: - nodeId - type properties: nodeId: type: string type: type: string - type: object required: - name properties: name: type: string description: '' title: Data source details - allOf: - type: object required: - nodeId - type properties: nodeId: type: string type: type: string - type: object required: - name - semanticViewTable properties: name: type: string semanticViewTable: type: string description: '' title: Semantic view details type: object edges: type: array items: type: object required: - source - target - type properties: source: type: string target: type: string type: type: string enum: - lookup - source - dependency examples: Response Example: value: dependencies: Ttd4meevWGks3ZYdVWt8X: nodeId: Ttd4meevWGks3ZYdVWt8X type: sheet name: Sum of Dock Count by City elementId: 5AbJJlOiPPtgpL3cCk7GqA 4ZJD7G8AR03qf2oySPwoc3: nodeId: 4ZJD7G8AR03qf2oySPwoc3 type: sheet name: Train Stations elementId: 3fqWi0z9SWwxuilnuq8w34 2MLjb1f67ldr3FMNI2L6Pf: nodeId: 2MLjb1f67ldr3FMNI2L6Pf type: table name: STATIONS edges: - source: 4ZJD7G8AR03qf2oySPwoc3 target: Ttd4meevWGks3ZYdVWt8X type: source - source: 2MLjb1f67ldr3FMNI2L6Pf target: 4ZJD7G8AR03qf2oySPwoc3 type: source default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/materialization-schedules: get: summary: List materialization schedules for a workbook description: "\n **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request.\n\n This endpoint retrieves a list of all materialization schedules associated with a workbook. Each schedule details when and how often specific workbook elements are automatically materialized to optimize performance and data freshness.\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - To retrieve additional pages of results, use the response of the `nextPage` parameter as the `page` query parameter in the following request.\n\n ### Usage scenarios\n - **Monitoring and management:** Administrators can monitor and manage the schedules for materialization to ensure optimal system performance.\n - **Audit and review:** Periodic reviews of materialization schedules can help in assessing the efficiency of data processes and making necessary adjustments.\n\n ### Best practices\n - Regularly review materialization schedules to align them with current data usage patterns and business needs.\n - Use pagination to manage large sets of data and improve response times of API calls." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: listMaterializationSchedules responses: '200': description: The response body. content: application/json: schema: oneOf: - type: object required: - entries properties: entries: type: array items: type: object required: - sheetId - elementId - elementName - schedule - configuredAt - paused properties: sheetId: type: string description: Identifier of the materialization schedule for the element title: Sheet ID elementId: type: string description: Identifier of the element being materialized title: Element ID elementName: type: string schedule: type: - object - 'null' properties: cronSpec: type: string description: Cron expression to use for the schedule timezone: type: string description: Timezone code, for example, PST configuredAt: type: string format: date-time paused: type: boolean description: '' title: Single Page - type: object required: - entries - nextPage properties: entries: type: array items: type: object required: - sheetId - elementId - elementName - schedule - configuredAt - paused properties: sheetId: type: string description: Identifier of the materialization schedule for the element title: Sheet ID elementId: type: string description: Identifier of the element being materialized title: Element ID elementName: type: string schedule: type: - object - 'null' properties: cronSpec: type: string description: Cron expression to use for the schedule timezone: type: string description: Timezone code, for example, PST configuredAt: type: string format: date-time paused: type: boolean nextPage: type: - string - 'null' description: '' title: Paginated Response default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/materializations: post: summary: Run a scheduled materialization for a workbook element description: "This endpoint runs a scheduled materialization for an element in a workbook. Materialization processes the data of the specified element, allowing the data to be stored or cached for optimized access and performance.\n\n For more details on materialization, see [Materialization](https://help.sigmacomputing.com/docs/materialization).\n\n ### Usage notes\n - The materialization schedule for the specified element must be created beforehand.\n - Retrieve the **sheetId** by calling the [/v2/workbooks/{workbookId}/materialization-schedules](https://help.sigmacomputing.com/reference/list-materialization-schedules) endpoint.\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n\n ### Usage scenarios\n - **Performance optimization:** Use this endpoint to improve response times for frequently accessed workbook elements.\n - **Data refresh:** Allows users to manually (programmatically) refresh the data of specific workbook elements to ensure that the latest data is available for analysis and reporting.\n\n ### Best practices\n - Prioritize materialization for elements that are heavily used or form critical components of business reports.\n - Monitor the performance impacts of materialization and adjust strategies as necessary to optimize resource usage and response times." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: materializeWorkbookElement requestBody: description: The request body. content: application/json: schema: type: object required: - sheetId properties: sheetId: type: string description: Identifier for the materialization schedule of this element. title: Sheet ID responses: '200': description: The response body. content: application/json: schema: type: object required: - materializationId properties: materializationId: type: string default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/materializations/{materializationId}: get: summary: Get a materialization job description: 'This endpoint retrieves details of a specific materialization job associated with a workbook by materializationId. It provides comprehensive information including status, start and completion times, which helps for monitoring and troubleshooting materialization. ### Usage notes - Retrieve the **materializationId** by calling the [/v2/workbooks/{workbookId}/materializations](https://help.sigmacomputing.com/reference/materialize-workbook-element) endpoint. ### Usage scenarios - **Job Monitoring:** Enables administrators to track the progress and status of materialization jobs, aiding in operational oversight. - **Troubleshooting:** Provides detailed information needed to diagnose and resolve issues in materialization processes. ### Best practices - Monitor materialization jobs regularly to detect and resolve issues promptly. - Use the detailed information provided by this endpoint to optimize materialization settings and performance.' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: materializationId schema: type: string description: Unique identifier of the materialization job title: materializationId in: path required: true operationId: getWorkbookMaterialization responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - materializationId - status properties: materializationId: type: string status: type: string - type: object properties: startedAt: type: string format: date-time readyAt: type: string format: date-time expiredAt: type: string format: date-time error: type: string default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/pages: get: summary: List workbook pages for a workbook description: 'This endpoint retrieves a list of all pages contained within a specified workbook. It is useful for applications needing to display an overview or navigate through different pages of a workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - To retrieve pages from version-tagged workbooks, pass the `tag` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `tags.name` included in the response for a given workbook. - To retrieve pages from a bookmark (saved view), pass the `bookmarkId` in the query parameters. Retrieve the bookmarkId by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) or [/v2/workbooks/{workbookId}/tags/:tagName/bookmarks](https://help.sigmacomputing.com/reference/get-tagged-workbook-bookmarks) endpoints. ### Usage scenarios - **Navigation:** Helps users and applications navigate through different pages of a workbook efficiently. - **Content Discovery:** Allows users to quickly view and access the variety of pages contained within a workbook. ### Best practices - Always name pages to make it easy for users to navigate. - Utilize pagination to manage and streamline the retrieval of large numbers of pages. - Ensure that users or systems querying this endpoint have appropriate permissions to access the workbook''s content.' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query - name: tag schema: type: string in: query - name: bookmarkId schema: type: string description: Unique identifier of the bookmark. title: Bookmark ID in: query operationId: listWorkbookPages responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: allOf: - type: object required: - pageId properties: pageId: type: string description: Unique identifier of the workbook page. - type: object properties: name: type: string hidden: type: boolean nextPage: type: - string - 'null' - type: object properties: total: type: number default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/pages/{pageId}/elements: get: summary: List elements in a workbook page description: 'This endpoint retrieves all elements from a specific page within a workbook, which lets you understand and interact with the individual components that make up the page, such as charts, tables, or controls. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint. - To retrieve pages from version-tagged workbooks, pass the `tag` in the query parameters with the tag name. Retrieve the tag name by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `tags.name` included in the response for a given workbook. - To retrieve pages from a bookmark (saved view), pass the `bookmarkId` in the query parameters. Retrieve the bookmarkId by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) or [/v2/workbooks/{workbookId}/tags/:tagName/bookmarks](https://help.sigmacomputing.com/reference/get-tagged-workbook-bookmarks) endpoints. ### Usage scenarios - **Detailed analysis:** Developers and users can retrieve specific elements for detailed data analysis or further manipulation. - **Interface customization:** Allows for dynamic interface construction where users can choose which elements to display or interact with. ### Best practices - Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience. - Validate both the workbookId and pageId to ensure they correspond to valid, accessible resources before making API calls.' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: pageId schema: type: string description: Unique identifier of the workbook page. in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query - name: tag schema: type: string in: query - name: bookmarkId schema: type: string description: Unique identifier of the bookmark. title: Bookmark ID in: query operationId: listWorkbookPageElements responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: allOf: - type: object required: - elementId properties: elementId: type: string - type: object properties: name: type: string type: type: string columns: type: array items: type: string vizualizationType: type: string error: type: string nextPage: type: - string - 'null' - type: object properties: total: type: number default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/queries: get: summary: List SQL queries in a workbook description: 'This endpoint retrieves a list of all SQL queries stored within a specific workbook. It is useful for developers and analysts who need to review or audit the queries being used for data manipulation and reporting within the workbook. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. ### Usage scenarios - **Audit and review:** Enables administrators and data governance teams to audit and review all the queries associated with a workbook for compliance and optimization. - **Query optimization:** Allows users to identify and optimize potentially inefficient or slow queries to improve performance. ### Best practices - Use pagination to manage large sets of queries efficiently, especially in workbooks with extensive data manipulation. - Regularly review queries as part of data governance practices to ensure they remain up to date and perform optimally.' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: listWorkbookQueries responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: allOf: - type: object required: - elementId properties: elementId: type: string - type: object properties: name: type: string sql: type: string error: type: string nextPage: type: - string - 'null' - type: object properties: total: type: number default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/restoreVersion: post: summary: Restore a workbook to a previous version description: 'Restore a workbook to a previous version. Restoring publishes a new version with the same contents as the version restored and does not delete or overwrite any versions created. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve available **version** numbers by calling the [/v2/workbooks/{workbookId}/version-history](https://help.sigmacomputing.com/reference/get-version-history) endpoint.' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: restoreWorkbookVersion requestBody: description: The request body. content: application/json: schema: type: object required: - version properties: version: type: number description: The document version to restore the workbook to. title: Version description: Body parameters for restoring a workbook version. responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - workbookId - workbookUrlId - name - url - path - latestVersion - ownerId properties: workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID workbookUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number ownerId: type: string - type: object required: - createdBy - updatedBy - createdAt - updatedAt properties: createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. - type: object properties: isArchived: type: boolean tags: type: array items: type: object required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt properties: versionTagId: type: string description: Unique identifier of the tag. title: Tag ID name: type: string sourceWorkbookVersion: type: number taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. title: Workbook ID workbookTaggedAt: type: string format: date-time description: type: string default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/saveTemplate: post: summary: Save a template from a workbook description: "Create a workbook template from an existing workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- The template owner defaults to the user associated with the API credentials. You can specify an owner in the request body with the `ownerId`. Retrieve the user ID to use as the ownerID by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint and using the `memberId` included in the response.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: saveTemplateFromWorkbook requestBody: description: The request body. content: application/json: schema: type: object properties: name: type: string description: Name of the template to create. title: Template name ownerId: type: string tag: type: string responses: '200': description: The response body. content: application/json: schema: type: object required: - templateId properties: templateId: type: string default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/schedules: get: summary: List scheduled workbook exports description: "\n **Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request.\n\n This endpoint retrieves a list of all scheduled exports for a specified workbook. These schedules represent planned events that can trigger exports based on various conditions and timings.\n ### Usage Notes\n - The **workbookId** in the path parameter identifies the workbook whose scheduled exports are to be listed. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - Use pagination query parameters to manage the volume of data returned by this endpoint.\n\n ### Usage Scenarios\n - **Schedule Overview:** Administrators or users with appropriate permissions can monitor and review all active scheduled exports associated with a workbook.\n - **Audit and Compliance:** This functionality is useful for auditing purposes to ensure that all scheduled operations are configured correctly and comply with organizational policies.\n\n ### Best Practices\n - Implement client-side handling to manage paginated data effectively, especially in cases where a workbook has a large number of scheduled exports.\n - Regularly audit schedules to keep them up-to-date and aligned with the current needs and workflows." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: listWorkbookSchedules responses: '200': description: The response body. content: application/json: schema: oneOf: - type: array items: allOf: - type: object required: - scheduledNotificationId - workbookId - schedule - configV2 - isSuspended - ownerId - lastUpdatedByUser - disabledAt - disabledBy properties: scheduledNotificationId: type: string description: Unique identifier of the scheduled export. title: Schedule ID workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID schedule: type: object required: - cronSpec - timezone properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. configV2: allOf: - type: object required: - title - messageBody - notificationAttachments properties: title: type: string messageBody: type: string notificationAttachments: type: array items: allOf: - type: object required: - formatOptions properties: formatOptions: oneOf: - type: object required: - type properties: type: type: string enum: - CSV - type: object required: - type properties: type: type: string enum: - JSON - type: object required: - type properties: type: type: string enum: - JSONL - type: object required: - type properties: type: type: string enum: - EXCEL - allOf: - type: object required: - type properties: type: type: string enum: - PDF - type: object properties: layout: type: string enum: - portrait - landscape scaleFactor: type: number - allOf: - type: object required: - type properties: type: type: string enum: - PNG - type: object properties: pixelWidth: type: - number - 'null' pixelHeight: type: - number - 'null' - type: object required: - type properties: type: type: string enum: - NONE - type: object properties: chartId: type: string workbookExportSource: oneOf: - type: object required: - type - elementId properties: type: type: string enum: - element elementId: type: string description: Export one element title: One element - type: object required: - type - pageId properties: type: type: string enum: - page pageId: type: string description: Export one page title: One page - type: object required: - type - nodeIds properties: type: type: string enum: - element nodeIds: type: array items: type: string description: Export multiple elements title: Multiple elements - type: object required: - type - nodeIds properties: type: type: string enum: - page nodeIds: type: array items: type: string description: Export multiple pages title: Multiple pages - type: object required: - type properties: type: type: string enum: - all description: Export all pages and elements in a workbook title: Entire workbook - type: object properties: includeLink: type: boolean runAsRecipient: type: boolean attachmentSettings: type: object properties: mergePdfAttachments: type: boolean zipAttachments: type: boolean conditionOptions: oneOf: - type: object required: - type properties: type: type: string enum: - always - type: object required: - type - conditions properties: type: type: string enum: - workbook conditions: type: array items: oneOf: - type: object required: - type - sheetId properties: type: type: string enum: - isEmpty sheetId: type: string - type: object required: - type - sheetId properties: type: type: string enum: - isNotEmpty sheetId: type: string - allOf: - type: object required: - type - sheetId - mode - columnId - op properties: type: type: string enum: - sheetColumn sheetId: type: string mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' - type: object required: - type - conditions properties: type: type: string enum: - worksheet conditions: type: array items: oneOf: - type: object required: - type properties: type: type: string enum: - isEmpty - type: object required: - type properties: type: type: string enum: - isNotEmpty - allOf: - type: object required: - type - mode - columnId - op properties: type: type: string enum: - queryColumn mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' - type: object required: - type - conditions properties: type: type: string enum: - dashboard conditions: type: array items: oneOf: - type: object required: - type - tileId properties: type: type: string enum: - isEmpty tileId: type: string - type: object required: - type - tileId properties: type: type: string enum: - isNotEmpty tileId: type: string - allOf: - type: object required: - type - tileId - mode - columnId - op properties: type: type: string enum: - chartColumn tileId: type: string mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' alertConfig: allOf: - type: object required: - window properties: window: type: string enum: - alltime - daily - weekly - always - type: object properties: volume: oneOf: - type: number - type: 'null' notificationName: type: string dashboardSettings: type: object properties: filters: type: array items: type: object required: - id - filterStr properties: id: type: string filterStr: type: string variableValues: $ref: '#/components/schemas/DashVariables' dynamicExportSettings: type: object properties: variables: type: object additionalProperties: oneOf: - type: object required: - type properties: type: type: string enum: - boolean - type: object required: - type properties: type: type: string enum: - number - type: object required: - type properties: type: type: string enum: - text - type: object required: - type properties: type: type: string enum: - date - type: object required: - type properties: type: type: string enum: - number-list - type: object required: - type properties: type: type: string enum: - text-list - type: object required: - type properties: type: type: string enum: - date-list - type: object required: - type properties: type: type: string enum: - boolean-list - type: object required: - type properties: type: type: string enum: - date-range - type: object required: - type properties: type: type: string enum: - number-range - type: object required: - type properties: type: type: string enum: - date-null - type: object required: - type properties: type: type: string enum: - number-null - type: object required: - type properties: type: type: string enum: - text-null - type: object required: - type properties: type: type: string enum: - boolean-null type: object dynamicRecipientSettings: type: object required: - sourceNodeId - recipientColumnId properties: sourceNodeId: type: string recipientColumnId: type: string rowLimit: type: number workbookVariant: type: object properties: tagId: type: string exploreKey: type: string bookmarkId: type: string embedOpts: type: object properties: embedId: type: string evalConnectionId: type: string formatting: type: - object - 'null' properties: pivotHeaderStyle: type: - string - 'null' enum: - merged - repeated isSuspended: type: boolean description: Whether the schedule is currently suspended. ownerId: type: string description: Unique identifier of the user who owns the schedule. title: Owner ID lastUpdatedByUser: type: string description: Unique identifier of the user who last updated the schedule. title: Last Updated By disabledAt: type: - string - 'null' format: date-time description: Timestamp when the schedule was disabled, or null if the schedule is active. title: Disabled At disabledBy: type: - string - 'null' description: Unique identifier of the member who disabled the schedule, or null if the schedule is active. title: Disabled By - type: object required: - createdBy - updatedBy - createdAt - updatedAt properties: createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. description: '' title: Single Page - type: object required: - entries - nextPage properties: entries: type: array items: allOf: - type: object required: - scheduledNotificationId - workbookId - schedule - configV2 - isSuspended - ownerId - lastUpdatedByUser - disabledAt - disabledBy properties: scheduledNotificationId: type: string description: Unique identifier of the scheduled export. title: Schedule ID workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID schedule: type: object required: - cronSpec - timezone properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. configV2: allOf: - type: object required: - title - messageBody - notificationAttachments properties: title: type: string messageBody: type: string notificationAttachments: type: array items: allOf: - type: object required: - formatOptions properties: formatOptions: oneOf: - type: object required: - type properties: type: type: string enum: - CSV - type: object required: - type properties: type: type: string enum: - JSON - type: object required: - type properties: type: type: string enum: - JSONL - type: object required: - type properties: type: type: string enum: - EXCEL - allOf: - type: object required: - type properties: type: type: string enum: - PDF - type: object properties: layout: type: string enum: - portrait - landscape scaleFactor: type: number - allOf: - type: object required: - type properties: type: type: string enum: - PNG - type: object properties: pixelWidth: type: - number - 'null' pixelHeight: type: - number - 'null' - type: object required: - type properties: type: type: string enum: - NONE - type: object properties: chartId: type: string workbookExportSource: oneOf: - type: object required: - type - elementId properties: type: type: string enum: - element elementId: type: string description: Export one element title: One element - type: object required: - type - pageId properties: type: type: string enum: - page pageId: type: string description: Export one page title: One page - type: object required: - type - nodeIds properties: type: type: string enum: - element nodeIds: type: array items: type: string description: Export multiple elements title: Multiple elements - type: object required: - type - nodeIds properties: type: type: string enum: - page nodeIds: type: array items: type: string description: Export multiple pages title: Multiple pages - type: object required: - type properties: type: type: string enum: - all description: Export all pages and elements in a workbook title: Entire workbook - type: object properties: includeLink: type: boolean runAsRecipient: type: boolean attachmentSettings: type: object properties: mergePdfAttachments: type: boolean zipAttachments: type: boolean conditionOptions: oneOf: - type: object required: - type properties: type: type: string enum: - always - type: object required: - type - conditions properties: type: type: string enum: - workbook conditions: type: array items: oneOf: - type: object required: - type - sheetId properties: type: type: string enum: - isEmpty sheetId: type: string - type: object required: - type - sheetId properties: type: type: string enum: - isNotEmpty sheetId: type: string - allOf: - type: object required: - type - sheetId - mode - columnId - op properties: type: type: string enum: - sheetColumn sheetId: type: string mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' - type: object required: - type - conditions properties: type: type: string enum: - worksheet conditions: type: array items: oneOf: - type: object required: - type properties: type: type: string enum: - isEmpty - type: object required: - type properties: type: type: string enum: - isNotEmpty - allOf: - type: object required: - type - mode - columnId - op properties: type: type: string enum: - queryColumn mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' - type: object required: - type - conditions properties: type: type: string enum: - dashboard conditions: type: array items: oneOf: - type: object required: - type - tileId properties: type: type: string enum: - isEmpty tileId: type: string - type: object required: - type - tileId properties: type: type: string enum: - isNotEmpty tileId: type: string - allOf: - type: object required: - type - tileId - mode - columnId - op properties: type: type: string enum: - chartColumn tileId: type: string mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' alertConfig: allOf: - type: object required: - window properties: window: type: string enum: - alltime - daily - weekly - always - type: object properties: volume: oneOf: - type: number - type: 'null' notificationName: type: string dashboardSettings: type: object properties: filters: type: array items: type: object required: - id - filterStr properties: id: type: string filterStr: type: string variableValues: $ref: '#/components/schemas/DashVariables' dynamicExportSettings: type: object properties: variables: type: object additionalProperties: oneOf: - type: object required: - type properties: type: type: string enum: - boolean - type: object required: - type properties: type: type: string enum: - number - type: object required: - type properties: type: type: string enum: - text - type: object required: - type properties: type: type: string enum: - date - type: object required: - type properties: type: type: string enum: - number-list - type: object required: - type properties: type: type: string enum: - text-list - type: object required: - type properties: type: type: string enum: - date-list - type: object required: - type properties: type: type: string enum: - boolean-list - type: object required: - type properties: type: type: string enum: - date-range - type: object required: - type properties: type: type: string enum: - number-range - type: object required: - type properties: type: type: string enum: - date-null - type: object required: - type properties: type: type: string enum: - number-null - type: object required: - type properties: type: type: string enum: - text-null - type: object required: - type properties: type: type: string enum: - boolean-null type: object dynamicRecipientSettings: type: object required: - sourceNodeId - recipientColumnId properties: sourceNodeId: type: string recipientColumnId: type: string rowLimit: type: number workbookVariant: type: object properties: tagId: type: string exploreKey: type: string bookmarkId: type: string embedOpts: type: object properties: embedId: type: string evalConnectionId: type: string formatting: type: - object - 'null' properties: pivotHeaderStyle: type: - string - 'null' enum: - merged - repeated isSuspended: type: boolean description: Whether the schedule is currently suspended. ownerId: type: string description: Unique identifier of the user who owns the schedule. title: Owner ID lastUpdatedByUser: type: string description: Unique identifier of the user who last updated the schedule. title: Last Updated By disabledAt: type: - string - 'null' format: date-time description: Timestamp when the schedule was disabled, or null if the schedule is active. title: Disabled At disabledBy: type: - string - 'null' description: Unique identifier of the member who disabled the schedule, or null if the schedule is active. title: Disabled By - type: object required: - createdBy - updatedBy - createdAt - updatedAt properties: createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. nextPage: type: - string - 'null' description: '' title: Paginated Response default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] post: summary: Add workbook schedule description: "Add a schedule to a workbook to export data from the workbook on a periodic basis.\n\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - Retrieve relevant IDs based on the export contents and destination:\n\n - To export to one or more Sigma users, retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.\n - To export to one or more Sigma teams, retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n - Retrieve the **pageId** by calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint.\n - Retrieve the **elementId** by first calling the [/v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/list-workbook-pages) endpoint, then calling the [/v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/list-workbook-page-elements) endpoint.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: postWorkbookSchedule requestBody: description: The request body. content: application/json: schema: allOf: - type: object required: - target - schedule properties: target: type: array items: type: object properties: teamId: type: string description: Unique identifier of the team to export to email: type: string description: Email address to export to ccEmail: type: string description: Email address to add as a Cc recipient bccEmail: type: string description: Email address to add as a Bcc recipient ccTeamId: type: string description: Unique identifier of the team to add as a Cc recipient bccTeamId: type: string description: Unique identifier of the team to add as a Bcc recipient slackConversationId: type: string description: Slack channel ID or member ID to export to googleSpreadsheetUrl: type: string description: URL of the Google Sheet to export to googleDriveFolderUrl: type: string description: URL of the Google Drive folder to export to webhookUrl: type: string description: URL of the webhook endpoint to export to description: One or more targets to send the workbook to. schedule: type: object required: - cronSpec - timezone properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. description: When to send the workbook export. - type: object properties: configV2: allOf: - type: object required: - title - messageBody - exportAttachments properties: title: type: string description: Title of the message messageBody: type: string description: Body of the message exportAttachments: type: array items: type: object required: - formatOptions - workbookExportSource properties: formatOptions: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - CSV description: CSV export format options title: CSV - allOf: - type: object required: - type properties: type: type: string enum: - JSONL description: JSONL export format options title: JSONL - allOf: - type: object required: - type properties: type: type: string enum: - JSON description: JSON export format options title: JSON - allOf: - type: object required: - type properties: type: type: string enum: - XLSX description: XLSX export format options title: XLSX - allOf: - type: object required: - type properties: type: type: string enum: - PDF - type: object properties: layout: type: string enum: - portrait - landscape description: PDF export format options title: PDF - type: object required: - type properties: type: type: string enum: - PNG description: PNG export format options title: PNG - type: object required: - type properties: type: type: string enum: - NONE description: No export format options title: Google Sheets description: Export format options title: Export format options workbookExportSource: oneOf: - type: object required: - type - elementIds properties: type: type: string enum: - element elementIds: type: array items: type: string description: Array of element identifiers to export title: Element IDs description: Export multiple elements title: Multiple elements export - type: object required: - type - pageIds properties: type: type: string enum: - page pageIds: type: array items: type: string description: Array of page identifiers to export title: Page IDs description: Export multiple pages title: Multiple pages export - type: object required: - type properties: type: type: string enum: - all description: Export all content title: Entire workbook export description: Workbook export source options title: Workbook export source description: Export attachment title: Export attachment description: Attachments to include in the export - type: object properties: exportName: type: string description: Name of the scheduled export title: Export name includeLink: type: boolean description: Include a link to the exported workbook title: Include link runAsRecipient: type: boolean description: Run the export queries as the recipient title: Run as recipient attachmentSettings: type: object properties: mergeAttachments: type: boolean description: Combines multiple PDF or XLSX attachments into a single file title: Merge attachments zipAttachments: type: boolean description: Send attachments as a .zip file title: Zip attachments description: Export attachment settings title: Export attachment settings workbookVariant: type: object properties: tagId: type: string description: Version tag to export title: Version tag ID bookmarkId: type: string description: Bookmark to export title: Bookmark ID description: Workbook variant title: Workbook variant conditionOptions: oneOf: - type: object required: - type properties: type: type: string enum: - always description: Always send the export title: Always - type: object required: - type - condition properties: type: type: string enum: - workbook condition: oneOf: - type: object required: - type - elementId properties: type: type: string enum: - isEmpty description: Type of condition title: Condition type elementId: type: string description: ID of the element title: Element ID description: If there's no data title: Element is empty - type: object required: - type - elementId properties: type: type: string enum: - isNotEmpty description: Type of condition title: Condition type elementId: type: string description: ID of the element title: Element ID description: If there's data title: Element is not empty - allOf: - type: object required: - type - elementId - columnId - op - mode properties: type: type: string enum: - column description: Type of condition title: Condition type elementId: type: string description: ID of the element title: Element ID columnId: type: string description: ID of the column title: Column ID op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNull - IsNotNull - Contains - StartsWith - EndsWith description: Operator title: Operator mode: type: string enum: - any - all description: Kind of condition evaluation title: Condition check - type: object properties: value: oneOf: - type: object required: - type - value properties: type: type: string enum: - boolean value: type: boolean description: Boolean value title: Boolean value - type: object required: - type - value properties: type: type: string enum: - integer value: type: string description: Integer value title: Integer value - type: object required: - type - value properties: type: type: string enum: - text value: type: string description: Text value title: Text value - type: object required: - type - date properties: type: type: string enum: - fixed-date date: type: string description: ISO-8601 date string title: ISO-8601 date string description: Fixed date selection title: Fixed date selection description: Column value title: Column value description: If a condition is met title: Column meets condition description: Send the export based on a condition title: Workbook condition description: Export condition options title: Export condition options workbookSettings: type: object properties: controlValues: type: object additionalProperties: oneOf: - oneOf: - type: object required: - type - value properties: type: type: string enum: - boolean value: type: boolean description: Boolean value title: Boolean value - type: object required: - type - value properties: type: type: string enum: - number value: type: number description: Number value title: Number value - type: object required: - type - value properties: type: type: string enum: - text value: type: string description: Text value title: Text value - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - type: object required: - type - date properties: type: type: string enum: - fixed-date date: type: string description: ISO-8601 date string title: ISO-8601 date string description: Fixed date selection title: Fixed date selection - type: object required: - type - unit - x properties: type: type: string enum: - prior - next unit: type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second x: type: number description: Relative date selection, for example "Next 4 days" title: Relative date selection - type: object required: - type properties: type: type: string enum: - date-null description: Null date value title: Null date value description: Date selection title: Date selection description: Date value title: Date value description: Scalar value title: Scalar value - type: object required: - type - value properties: type: type: string enum: - boolean-list value: allOf: - type: object required: - 'true' - 'false' properties: 'true': type: boolean 'false': type: boolean - type: object properties: 'null': type: boolean description: Boolean list value title: Boolean list value - oneOf: - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: object required: - type - value properties: type: type: string enum: - number value: type: number description: Number value title: Number value - type: object required: - type properties: type: type: string enum: - number-null description: Null number value title: Null number value description: Number list value title: Number list value - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: type: string description: Text value title: Text value - type: object required: - type properties: type: type: string enum: - text-null description: Null text value title: Null text value description: Text list value title: Text list value - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: object required: - type - date properties: type: type: string enum: - fixed-date date: type: string description: ISO-8601 date string title: ISO-8601 date string description: Fixed date selection title: Fixed date selection - type: object required: - type properties: type: type: string enum: - date-null description: Null date value title: Null date value description: Date list value title: Date list value description: List value title: List value - type: object required: - type - value properties: type: type: string enum: - hierarchical-list value: type: array items: type: array items: type: object required: - type - value properties: type: type: string enum: - text value: type: string description: Text value title: Text value description: 'Array of hierarchy paths. Each path is an array of segments, from the highest selected level of the hierarchy down to the lowest selected level of the hierarchy. Each segment is a `{type: "text", value: string}` object. For example, a Region/State/City hierarchy control with Oakland selected would be represented as `[[{"type":"text","value":"West"}, {"type":"text","value":"California"}, {"type":"text","value":"Oakland"}]]`' title: Hierarchy paths description: Hierarchical list value title: Hierarchical list value - type: object required: - type - min - max properties: type: type: string enum: - date-range min: oneOf: - type: object required: - type - date properties: type: type: string enum: - fixed-date date: type: string description: ISO-8601 date string title: ISO-8601 date string description: Fixed date selection title: Fixed date selection - type: object required: - type - unit - x properties: type: type: string enum: - prior - next unit: type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second x: type: number description: Relative date selection, for example "Next 4 days" title: Relative date selection - type: object required: - type properties: type: type: string enum: - date-null description: Null date value title: Null date value description: Date selection title: Date selection max: oneOf: - type: object required: - type - date properties: type: type: string enum: - fixed-date date: type: string description: ISO-8601 date string title: ISO-8601 date string description: Fixed date selection title: Fixed date selection - type: object required: - type - unit - x properties: type: type: string enum: - prior - next unit: type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second x: type: number description: Relative date selection, for example "Next 4 days" title: Relative date selection - type: object required: - type properties: type: type: string enum: - date-null description: Null date value title: Null date value description: Date selection title: Date selection description: Date range value title: Date range value - allOf: - type: object required: - type properties: type: type: string enum: - number-range - type: object properties: min: type: number description: Minimum value of the range title: Minimum value max: type: number description: Maximum value of the range title: Maximum value description: Number range value title: Number range value - oneOf: - type: object required: - type properties: type: type: string enum: - date-null description: Null date value title: Null date value - type: object required: - type properties: type: type: string enum: - number-null description: Null number value title: Null number value - type: object required: - type properties: type: type: string enum: - text-null description: Null text value title: Null text value - type: object required: - type properties: type: type: string enum: - boolean-null description: Null boolean value title: Null boolean value description: Null value title: Null value description: Variable value title: Variable value type: object description: This object maps control IDs to the values that they should have when exporting the workbook. title: Control values description: Workbook settings title: Workbook settings formatting: type: object properties: pivotHeaderStyle: type: string enum: - merged - repeated description: Style of pivot table headers title: Pivot header style includeMetadata: type: boolean description: Whether to include metadata in XLSX exports title: Include metadata description: Export formatting options title: Export formatting options description: Configuration settings for the export schedule. config: allOf: - type: object required: - formatOptions - title - messageBody properties: formatOptions: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - CSV description: CSV export format options title: CSV - allOf: - type: object required: - type properties: type: type: string enum: - JSONL description: JSONL export format options title: JSONL - allOf: - type: object required: - type properties: type: type: string enum: - JSON description: JSON export format options title: JSON - allOf: - type: object required: - type properties: type: type: string enum: - XLSX description: XLSX export format options title: XLSX - allOf: - type: object required: - type properties: type: type: string enum: - PDF - type: object properties: layout: type: string enum: - portrait - landscape description: PDF export format options title: PDF - type: object required: - type properties: type: type: string enum: - PNG description: PNG export format options title: PNG - type: object required: - type properties: type: type: string enum: - NONE description: No export format options title: Google Sheets description: Export format options title: type: string description: Title of the message messageBody: type: string description: Body of the message - type: object properties: includeLink: type: boolean description: Whether to include a link to the exported folder or document in the body of the message runAsRecipient: type: boolean description: Whether to run the export as if it were being run by the recipient rowLimit: type: number description: Maximum number of rows to export chartId: type: string description: Identifier of the chart to export parameters: type: object additionalProperties: type: string description: "Specify the control ID and control value of one or more control elements in the workbook or report to filter the returned data. The control must exist in the Sigma workbook or report and target an element before you can export based on the control value.\n\n**Syntax**\n{ control-id: control-value }\n\nThe control-id is configured in the Sigma workbook or report. The control-value is the value that is passed to the control.\n\nValues can take multiple forms, depending on the data type of the control:\n\n**Boolean**\n\n- Single value: \"true\" | \"false\" | \":null\"\n- List of Boolean: \"true,false,:null\" (No space after the comma.)\n\n**Number**\n\n- Single value: \"10.54\", \":null\"\n- List of values: \"10.54,23.45,:null\" (No space after the comma.)\n- Range of numbers: \"min:10.54,max:23.45\" (No space after the comma or colon.)\n\n**Text**\n\n- Single value: \"some-text\" | \":null\" | \":empty\"\n- List of values: \"some-text,more-text,:null,:empty\" (No space after the comma.)\n\n**Date**\n\nAll dates use UTC time zones.\n\n- Fixed date using ISO-6801 format: \"2022-01-01T01:01:59\" | \":null\"\n - Formats supported (where: %Y: year, %m: month, %d: day, %H:hours, %M: minutes, %S: seconds):\n - %Y-%m-%d\n - %Y-%m-%dT%H:%M\n - %Y-%m-%dT%H:%M:%S\n- List of fixed dates: \"2022-01-01T01:01:59,2022-02-02T02:02:59,:null\"\n- Relative date: \"prior-day-3\" | \"next-day-3\"\n - Format: [prior|next]-[year|quarter|month|week|isoWeek|day|hour|minute]-[number]\n- Date range: \"min:2022-01-01T01:01:59,max:next-day-3\" (No spaces after the comma or colon.)\n - Leave max blank for \"on or after\" and min blank for \"on or before\", for example:\n - \"Date-Range\": \"min:2020-04-01,max:\"\n - \"Date-Range\": \"min:,max:next-day-3\"\n\n**Notes**\n\n- \":null\" is a special value that denotes the null primitive value.\n- \":empty\" is a special value that denotes the empty string \"\".\n\nUse [URL encoding](https://help.sigmacomputing.com/docs/special-characters-for-url-parameters) to encode characters in your control values (such as commas) to prevent the system from interpreting them as separators.\n\nFor example:\n\"New York, NY,Boston, MA\" can be encoded as:\n\n\"New%20York%2C%20NY,Boston%2C%20MA\"" description: '**[Deprecated]** Configuration settings for the export.' description: type: - string - 'null' description: Description of the scheduled export ownerId: type: string description: ID of the user (member) to own the export. responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - scheduledNotificationId - workbookId - schedule - configV2 - isSuspended - ownerId - lastUpdatedByUser - disabledAt - disabledBy properties: scheduledNotificationId: type: string description: Unique identifier of the scheduled export. title: Schedule ID workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID schedule: type: object required: - cronSpec - timezone properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. configV2: allOf: - type: object required: - title - messageBody - notificationAttachments properties: title: type: string messageBody: type: string notificationAttachments: type: array items: allOf: - type: object required: - formatOptions properties: formatOptions: oneOf: - type: object required: - type properties: type: type: string enum: - CSV - type: object required: - type properties: type: type: string enum: - JSON - type: object required: - type properties: type: type: string enum: - JSONL - type: object required: - type properties: type: type: string enum: - EXCEL - allOf: - type: object required: - type properties: type: type: string enum: - PDF - type: object properties: layout: type: string enum: - portrait - landscape scaleFactor: type: number - allOf: - type: object required: - type properties: type: type: string enum: - PNG - type: object properties: pixelWidth: type: - number - 'null' pixelHeight: type: - number - 'null' - type: object required: - type properties: type: type: string enum: - NONE - type: object properties: chartId: type: string workbookExportSource: oneOf: - type: object required: - type - elementId properties: type: type: string enum: - element elementId: type: string description: Export one element title: One element - type: object required: - type - pageId properties: type: type: string enum: - page pageId: type: string description: Export one page title: One page - type: object required: - type - nodeIds properties: type: type: string enum: - element nodeIds: type: array items: type: string description: Export multiple elements title: Multiple elements - type: object required: - type - nodeIds properties: type: type: string enum: - page nodeIds: type: array items: type: string description: Export multiple pages title: Multiple pages - type: object required: - type properties: type: type: string enum: - all description: Export all pages and elements in a workbook title: Entire workbook - type: object properties: includeLink: type: boolean runAsRecipient: type: boolean attachmentSettings: type: object properties: mergePdfAttachments: type: boolean zipAttachments: type: boolean conditionOptions: oneOf: - type: object required: - type properties: type: type: string enum: - always - type: object required: - type - conditions properties: type: type: string enum: - workbook conditions: type: array items: oneOf: - type: object required: - type - sheetId properties: type: type: string enum: - isEmpty sheetId: type: string - type: object required: - type - sheetId properties: type: type: string enum: - isNotEmpty sheetId: type: string - allOf: - type: object required: - type - sheetId - mode - columnId - op properties: type: type: string enum: - sheetColumn sheetId: type: string mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' - type: object required: - type - conditions properties: type: type: string enum: - worksheet conditions: type: array items: oneOf: - type: object required: - type properties: type: type: string enum: - isEmpty - type: object required: - type properties: type: type: string enum: - isNotEmpty - allOf: - type: object required: - type - mode - columnId - op properties: type: type: string enum: - queryColumn mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' - type: object required: - type - conditions properties: type: type: string enum: - dashboard conditions: type: array items: oneOf: - type: object required: - type - tileId properties: type: type: string enum: - isEmpty tileId: type: string - type: object required: - type - tileId properties: type: type: string enum: - isNotEmpty tileId: type: string - allOf: - type: object required: - type - tileId - mode - columnId - op properties: type: type: string enum: - chartColumn tileId: type: string mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' alertConfig: allOf: - type: object required: - window properties: window: type: string enum: - alltime - daily - weekly - always - type: object properties: volume: oneOf: - type: number - type: 'null' notificationName: type: string dashboardSettings: type: object properties: filters: type: array items: type: object required: - id - filterStr properties: id: type: string filterStr: type: string variableValues: $ref: '#/components/schemas/DashVariables' dynamicExportSettings: type: object properties: variables: type: object additionalProperties: oneOf: - type: object required: - type properties: type: type: string enum: - boolean - type: object required: - type properties: type: type: string enum: - number - type: object required: - type properties: type: type: string enum: - text - type: object required: - type properties: type: type: string enum: - date - type: object required: - type properties: type: type: string enum: - number-list - type: object required: - type properties: type: type: string enum: - text-list - type: object required: - type properties: type: type: string enum: - date-list - type: object required: - type properties: type: type: string enum: - boolean-list - type: object required: - type properties: type: type: string enum: - date-range - type: object required: - type properties: type: type: string enum: - number-range - type: object required: - type properties: type: type: string enum: - date-null - type: object required: - type properties: type: type: string enum: - number-null - type: object required: - type properties: type: type: string enum: - text-null - type: object required: - type properties: type: type: string enum: - boolean-null type: object dynamicRecipientSettings: type: object required: - sourceNodeId - recipientColumnId properties: sourceNodeId: type: string recipientColumnId: type: string rowLimit: type: number workbookVariant: type: object properties: tagId: type: string exploreKey: type: string bookmarkId: type: string embedOpts: type: object properties: embedId: type: string evalConnectionId: type: string formatting: type: - object - 'null' properties: pivotHeaderStyle: type: - string - 'null' enum: - merged - repeated isSuspended: type: boolean description: Whether the schedule is currently suspended. ownerId: type: string description: Unique identifier of the user who owns the schedule. title: Owner ID lastUpdatedByUser: type: string description: Unique identifier of the user who last updated the schedule. title: Last Updated By disabledAt: type: - string - 'null' format: date-time description: Timestamp when the schedule was disabled, or null if the schedule is active. title: Disabled At disabledBy: type: - string - 'null' description: Unique identifier of the member who disabled the schedule, or null if the schedule is active. title: Disabled By - type: object required: - createdBy - updatedBy - createdAt - updatedAt properties: createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/schedules/{scheduleId}: patch: summary: Update a workbook schedule description: "Update a schedule of a workbook to export data from the workbook on a periodic basis.\n\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - Retrieve the **scheduleId** by calling the [/v2/workbooks/{workbookId}/schedules](https://help.sigmacomputing.com/reference/list-workbook-schedules) endpoint.\n - To add or update a team recipient, retrieve the **teamId** by calling the [/v2/teams](https://help.sigmacomputing.com/reference/list-teams) endpoint.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: scheduleId schema: type: string description: Unique identifier of the schedule. title: Schedule ID in: path required: true operationId: updateWorkbookSchedule requestBody: description: The request body. content: application/json: schema: type: object properties: target: type: array items: type: object properties: teamId: type: string description: Unique identifier of the team to export to email: type: string description: Email address to export to ccEmail: type: string description: Email address to add as a Cc recipient bccEmail: type: string description: Email address to add as a Bcc recipient ccTeamId: type: string description: Unique identifier of the team to add as a Cc recipient bccTeamId: type: string description: Unique identifier of the team to add as a Bcc recipient slackConversationId: type: string description: Slack channel ID or member ID to export to googleSpreadsheetUrl: type: string description: URL of the Google Sheet to export to googleDriveFolderUrl: type: string description: URL of the Google Drive folder to export to webhookUrl: type: string description: URL of the webhook endpoint to export to description: One or more targets to send the workbook to. schedule: type: object properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. description: When to send the workbook export. configV2: type: object properties: title: type: string description: Title of the message messageBody: type: string description: Body of the message exportAttachments: type: array items: type: object required: - formatOptions - workbookExportSource properties: formatOptions: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - CSV description: CSV export format options title: CSV - allOf: - type: object required: - type properties: type: type: string enum: - JSONL description: JSONL export format options title: JSONL - allOf: - type: object required: - type properties: type: type: string enum: - JSON description: JSON export format options title: JSON - allOf: - type: object required: - type properties: type: type: string enum: - XLSX description: XLSX export format options title: XLSX - allOf: - type: object required: - type properties: type: type: string enum: - PDF - type: object properties: layout: type: string enum: - portrait - landscape description: PDF export format options title: PDF - type: object required: - type properties: type: type: string enum: - PNG description: PNG export format options title: PNG - type: object required: - type properties: type: type: string enum: - NONE description: No export format options title: Google Sheets description: Export format options title: Export format options workbookExportSource: oneOf: - type: object required: - type - elementIds properties: type: type: string enum: - element elementIds: type: array items: type: string description: Array of element identifiers to export title: Element IDs description: Export multiple elements title: Multiple elements export - type: object required: - type - pageIds properties: type: type: string enum: - page pageIds: type: array items: type: string description: Array of page identifiers to export title: Page IDs description: Export multiple pages title: Multiple pages export - type: object required: - type properties: type: type: string enum: - all description: Export all content title: Entire workbook export description: Workbook export source options title: Workbook export source description: Export attachment title: Export attachment description: Attachments to include in the export exportName: type: string description: Name of the scheduled export title: Export name includeLink: type: boolean description: Include a link to the exported workbook title: Include link runAsRecipient: type: boolean description: Run the export queries as the recipient title: Run as recipient attachmentSettings: type: object properties: mergeAttachments: type: boolean description: Combines multiple PDF or XLSX attachments into a single file title: Merge attachments zipAttachments: type: boolean description: Send attachments as a .zip file title: Zip attachments description: Export attachment settings title: Export attachment settings workbookVariant: type: object properties: tagId: type: string description: Version tag to export title: Version tag ID bookmarkId: type: string description: Bookmark to export title: Bookmark ID description: Workbook variant title: Workbook variant conditionOptions: oneOf: - type: object required: - type properties: type: type: string enum: - always description: Always send the export title: Always - type: object required: - type - condition properties: type: type: string enum: - workbook condition: oneOf: - type: object required: - type - elementId properties: type: type: string enum: - isEmpty description: Type of condition title: Condition type elementId: type: string description: ID of the element title: Element ID description: If there's no data title: Element is empty - type: object required: - type - elementId properties: type: type: string enum: - isNotEmpty description: Type of condition title: Condition type elementId: type: string description: ID of the element title: Element ID description: If there's data title: Element is not empty - allOf: - type: object required: - type - elementId - columnId - op - mode properties: type: type: string enum: - column description: Type of condition title: Condition type elementId: type: string description: ID of the element title: Element ID columnId: type: string description: ID of the column title: Column ID op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNull - IsNotNull - Contains - StartsWith - EndsWith description: Operator title: Operator mode: type: string enum: - any - all description: Kind of condition evaluation title: Condition check - type: object properties: value: oneOf: - type: object required: - type - value properties: type: type: string enum: - boolean value: type: boolean description: Boolean value title: Boolean value - type: object required: - type - value properties: type: type: string enum: - integer value: type: string description: Integer value title: Integer value - type: object required: - type - value properties: type: type: string enum: - text value: type: string description: Text value title: Text value - type: object required: - type - date properties: type: type: string enum: - fixed-date date: type: string description: ISO-8601 date string title: ISO-8601 date string description: Fixed date selection title: Fixed date selection description: Column value title: Column value description: If a condition is met title: Column meets condition description: Send the export based on a condition title: Workbook condition description: Export condition options title: Export condition options workbookSettings: type: object properties: controlValues: type: object additionalProperties: oneOf: - oneOf: - type: object required: - type - value properties: type: type: string enum: - boolean value: type: boolean description: Boolean value title: Boolean value - type: object required: - type - value properties: type: type: string enum: - number value: type: number description: Number value title: Number value - type: object required: - type - value properties: type: type: string enum: - text value: type: string description: Text value title: Text value - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - type: object required: - type - date properties: type: type: string enum: - fixed-date date: type: string description: ISO-8601 date string title: ISO-8601 date string description: Fixed date selection title: Fixed date selection - type: object required: - type - unit - x properties: type: type: string enum: - prior - next unit: type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second x: type: number description: Relative date selection, for example "Next 4 days" title: Relative date selection - type: object required: - type properties: type: type: string enum: - date-null description: Null date value title: Null date value description: Date selection title: Date selection description: Date value title: Date value description: Scalar value title: Scalar value - type: object required: - type - value properties: type: type: string enum: - boolean-list value: allOf: - type: object required: - 'true' - 'false' properties: 'true': type: boolean 'false': type: boolean - type: object properties: 'null': type: boolean description: Boolean list value title: Boolean list value - oneOf: - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: object required: - type - value properties: type: type: string enum: - number value: type: number description: Number value title: Number value - type: object required: - type properties: type: type: string enum: - number-null description: Null number value title: Null number value description: Number list value title: Number list value - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: type: string description: Text value title: Text value - type: object required: - type properties: type: type: string enum: - text-null description: Null text value title: Null text value description: Text list value title: Text list value - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: object required: - type - date properties: type: type: string enum: - fixed-date date: type: string description: ISO-8601 date string title: ISO-8601 date string description: Fixed date selection title: Fixed date selection - type: object required: - type properties: type: type: string enum: - date-null description: Null date value title: Null date value description: Date list value title: Date list value description: List value title: List value - type: object required: - type - value properties: type: type: string enum: - hierarchical-list value: type: array items: type: array items: type: object required: - type - value properties: type: type: string enum: - text value: type: string description: Text value title: Text value description: 'Array of hierarchy paths. Each path is an array of segments, from the highest selected level of the hierarchy down to the lowest selected level of the hierarchy. Each segment is a `{type: "text", value: string}` object. For example, a Region/State/City hierarchy control with Oakland selected would be represented as `[[{"type":"text","value":"West"}, {"type":"text","value":"California"}, {"type":"text","value":"Oakland"}]]`' title: Hierarchy paths description: Hierarchical list value title: Hierarchical list value - type: object required: - type - min - max properties: type: type: string enum: - date-range min: oneOf: - type: object required: - type - date properties: type: type: string enum: - fixed-date date: type: string description: ISO-8601 date string title: ISO-8601 date string description: Fixed date selection title: Fixed date selection - type: object required: - type - unit - x properties: type: type: string enum: - prior - next unit: type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second x: type: number description: Relative date selection, for example "Next 4 days" title: Relative date selection - type: object required: - type properties: type: type: string enum: - date-null description: Null date value title: Null date value description: Date selection title: Date selection max: oneOf: - type: object required: - type - date properties: type: type: string enum: - fixed-date date: type: string description: ISO-8601 date string title: ISO-8601 date string description: Fixed date selection title: Fixed date selection - type: object required: - type - unit - x properties: type: type: string enum: - prior - next unit: type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second x: type: number description: Relative date selection, for example "Next 4 days" title: Relative date selection - type: object required: - type properties: type: type: string enum: - date-null description: Null date value title: Null date value description: Date selection title: Date selection description: Date range value title: Date range value - allOf: - type: object required: - type properties: type: type: string enum: - number-range - type: object properties: min: type: number description: Minimum value of the range title: Minimum value max: type: number description: Maximum value of the range title: Maximum value description: Number range value title: Number range value - oneOf: - type: object required: - type properties: type: type: string enum: - date-null description: Null date value title: Null date value - type: object required: - type properties: type: type: string enum: - number-null description: Null number value title: Null number value - type: object required: - type properties: type: type: string enum: - text-null description: Null text value title: Null text value - type: object required: - type properties: type: type: string enum: - boolean-null description: Null boolean value title: Null boolean value description: Null value title: Null value description: Variable value title: Variable value type: object description: This object maps control IDs to the values that they should have when exporting the workbook. title: Control values description: Workbook settings title: Workbook settings formatting: type: object properties: pivotHeaderStyle: type: string enum: - merged - repeated description: Style of pivot table headers title: Pivot header style includeMetadata: type: boolean description: Whether to include metadata in XLSX exports title: Include metadata description: Export formatting options title: Export formatting options description: Configuration settings for the export schedule. description: type: - string - 'null' description: Description of the scheduled export suspensionAction: type: string enum: - pause - resume description: Action to take on the schedule. Use `pause` to pause the schedule and `resume` to resume the schedule. responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - scheduledNotificationId - workbookId - schedule - configV2 - isSuspended - ownerId - lastUpdatedByUser - disabledAt - disabledBy properties: scheduledNotificationId: type: string description: Unique identifier of the scheduled export. title: Schedule ID workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID schedule: type: object required: - cronSpec - timezone properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. configV2: allOf: - type: object required: - title - messageBody - notificationAttachments properties: title: type: string messageBody: type: string notificationAttachments: type: array items: allOf: - type: object required: - formatOptions properties: formatOptions: oneOf: - type: object required: - type properties: type: type: string enum: - CSV - type: object required: - type properties: type: type: string enum: - JSON - type: object required: - type properties: type: type: string enum: - JSONL - type: object required: - type properties: type: type: string enum: - EXCEL - allOf: - type: object required: - type properties: type: type: string enum: - PDF - type: object properties: layout: type: string enum: - portrait - landscape scaleFactor: type: number - allOf: - type: object required: - type properties: type: type: string enum: - PNG - type: object properties: pixelWidth: type: - number - 'null' pixelHeight: type: - number - 'null' - type: object required: - type properties: type: type: string enum: - NONE - type: object properties: chartId: type: string workbookExportSource: oneOf: - type: object required: - type - elementId properties: type: type: string enum: - element elementId: type: string description: Export one element title: One element - type: object required: - type - pageId properties: type: type: string enum: - page pageId: type: string description: Export one page title: One page - type: object required: - type - nodeIds properties: type: type: string enum: - element nodeIds: type: array items: type: string description: Export multiple elements title: Multiple elements - type: object required: - type - nodeIds properties: type: type: string enum: - page nodeIds: type: array items: type: string description: Export multiple pages title: Multiple pages - type: object required: - type properties: type: type: string enum: - all description: Export all pages and elements in a workbook title: Entire workbook - type: object properties: includeLink: type: boolean runAsRecipient: type: boolean attachmentSettings: type: object properties: mergePdfAttachments: type: boolean zipAttachments: type: boolean conditionOptions: oneOf: - type: object required: - type properties: type: type: string enum: - always - type: object required: - type - conditions properties: type: type: string enum: - workbook conditions: type: array items: oneOf: - type: object required: - type - sheetId properties: type: type: string enum: - isEmpty sheetId: type: string - type: object required: - type - sheetId properties: type: type: string enum: - isNotEmpty sheetId: type: string - allOf: - type: object required: - type - sheetId - mode - columnId - op properties: type: type: string enum: - sheetColumn sheetId: type: string mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' - type: object required: - type - conditions properties: type: type: string enum: - worksheet conditions: type: array items: oneOf: - type: object required: - type properties: type: type: string enum: - isEmpty - type: object required: - type properties: type: type: string enum: - isNotEmpty - allOf: - type: object required: - type - mode - columnId - op properties: type: type: string enum: - queryColumn mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' - type: object required: - type - conditions properties: type: type: string enum: - dashboard conditions: type: array items: oneOf: - type: object required: - type - tileId properties: type: type: string enum: - isEmpty tileId: type: string - type: object required: - type - tileId properties: type: type: string enum: - isNotEmpty tileId: type: string - allOf: - type: object required: - type - tileId - mode - columnId - op properties: type: type: string enum: - chartColumn tileId: type: string mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' alertConfig: allOf: - type: object required: - window properties: window: type: string enum: - alltime - daily - weekly - always - type: object properties: volume: oneOf: - type: number - type: 'null' notificationName: type: string dashboardSettings: type: object properties: filters: type: array items: type: object required: - id - filterStr properties: id: type: string filterStr: type: string variableValues: $ref: '#/components/schemas/DashVariables' dynamicExportSettings: type: object properties: variables: type: object additionalProperties: oneOf: - type: object required: - type properties: type: type: string enum: - boolean - type: object required: - type properties: type: type: string enum: - number - type: object required: - type properties: type: type: string enum: - text - type: object required: - type properties: type: type: string enum: - date - type: object required: - type properties: type: type: string enum: - number-list - type: object required: - type properties: type: type: string enum: - text-list - type: object required: - type properties: type: type: string enum: - date-list - type: object required: - type properties: type: type: string enum: - boolean-list - type: object required: - type properties: type: type: string enum: - date-range - type: object required: - type properties: type: type: string enum: - number-range - type: object required: - type properties: type: type: string enum: - date-null - type: object required: - type properties: type: type: string enum: - number-null - type: object required: - type properties: type: type: string enum: - text-null - type: object required: - type properties: type: type: string enum: - boolean-null type: object dynamicRecipientSettings: type: object required: - sourceNodeId - recipientColumnId properties: sourceNodeId: type: string recipientColumnId: type: string rowLimit: type: number workbookVariant: type: object properties: tagId: type: string exploreKey: type: string bookmarkId: type: string embedOpts: type: object properties: embedId: type: string evalConnectionId: type: string formatting: type: - object - 'null' properties: pivotHeaderStyle: type: - string - 'null' enum: - merged - repeated isSuspended: type: boolean description: Whether the schedule is currently suspended. ownerId: type: string description: Unique identifier of the user who owns the schedule. title: Owner ID lastUpdatedByUser: type: string description: Unique identifier of the user who last updated the schedule. title: Last Updated By disabledAt: type: - string - 'null' format: date-time description: Timestamp when the schedule was disabled, or null if the schedule is active. title: Disabled At disabledBy: type: - string - 'null' description: Unique identifier of the member who disabled the schedule, or null if the schedule is active. title: Disabled By - type: object required: - createdBy - updatedBy - createdAt - updatedAt properties: createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] delete: summary: Delete a scheduled export for a workbook description: "This endpoint deletes a specific scheduled export from a workbook. Deleting a schedule prevents any previously configured exports or alerts from being triggered at the scheduled times.\n\n ### Usage notes\n - The `workbookId` in the path is required to identify the workbook. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - The `scheduleId` in the path is required to specify which schedule to delete. Retrieve the **scheduleId** by calling the [/v2/workbooks/{workbookId}/schedules](https://help.sigmacomputing.com/reference/list-workbook-schedules) endpoint and using the `scheduledNotificationId` in the response.\n\n ### Usage scenarios\n - **Cleanup operations:** Use this endpoint to remove unnecessary or outdated schedules that are no longer relevant to the workbook's current use case.\n - **Configuration updates:** When a workbook's usage patterns change, corresponding schedules might need to be deleted to align with the new setup.\n\n ### Best practices\n - Make sure that deleting a given schedule is in compliance with your organization's data governance and operational policies.\n - Verify the `scheduleId` and `workbookId` before making a deletion request to prevent errors." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: scheduleId schema: type: string description: Unique identifier of the schedule. title: Schedule ID in: path required: true operationId: deleteWorkbookSchedule responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/schema: get: summary: Get workbook schema description: "The Workbook Schema API is deprecated as of December 15, 2023. This endpoint is no longer compatible with workbook layouts. Workflows that use this endpoint must be replaced with the new endpoints listed below. The components in Workbook Schema API are available through individual endpoints to minimize the retrieval of unnecessary data.\n\n- [GET v2/workbooks/{workbookId}/pages](https://help.sigmacomputing.com/reference/listworkbookpages)\n- [GET v2/workbooks/{workbookId}/pages/{pageId}/elements](https://help.sigmacomputing.com/reference/listworkbookpageelements)\n- [GET v2/workbooks/{workbookId}/queries](https://help.sigmacomputing.com/reference/listworkbookqueries)\n- [GET v2/workbooks/{workbookId}/elements/{elementId}/query](https://help.sigmacomputing.com/reference/getelementquery)\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: includeSql schema: type: boolean in: query - name: tag schema: type: string in: query operationId: getWorkbookSchema responses: '200': description: The response body. content: application/json: schema: type: object required: - workbookId - workbookUrlId - pages - sheets - variables - elements - sqlQueries - sqlQueryErrors properties: workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID workbookUrlId: type: string pages: type: object additionalProperties: {} sheets: type: object additionalProperties: {} variables: type: object additionalProperties: {} elements: type: object additionalProperties: {} sqlQueries: type: object additionalProperties: type: string sqlQueryErrors: type: object additionalProperties: type: object required: - message properties: message: type: string examples: Response Example: value: workbookId: 88889999-aaaa-bbbb-cccc-ddddeeeeffff workbookUrlId: 57a96EMo3GVJG73179MV2l pages: page1: '[Object Page_t]' sheets: sheet1: '[Object Sheet_t]' variables: variable1: '[Object Variable_t]' elements: element1: '[Object Element_t]' element2: '[Object Element_t]' sqlQueries: element1: SELECT customerID, sum(AMOUNT) FROM ORDERS GROUP BY customerID sqlQueryErrors: element2: message: 'SQL compilation error: xxx' default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks deprecated: true security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/send: post: summary: Export a workbook description: "Export a workbook to one or more destinations, such as an email address, a Slack channel, or cloud storage.\n\n ### Usage notes\n\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - This endpoint is rate limited to 100 requests per minute.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: sendWorkbook requestBody: description: The request body. content: application/json: schema: allOf: - type: object properties: parameters: type: object additionalProperties: type: string timeout: type: number conditions: type: array items: oneOf: - type: object required: - type - elementId properties: type: type: string enum: - isEmpty elementId: type: string description: '' title: Is Empty - type: object required: - type - elementId properties: type: type: string enum: - isNotEmpty elementId: type: string description: '' title: Is Not Empty - allOf: - type: object required: - type - elementId - columnId - op - mode properties: type: type: string enum: - sheetColumn elementId: type: string columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNull - IsNotNull - Contains - StartsWith - EndsWith description: Operator mode: type: string enum: - any - all description: Check condition - type: object properties: value: oneOf: - $ref: '#/components/schemas/DataTypes' - type: 'null' description: Data value title: Value to check against the operator and selected condition description: '' title: Specific column value in an element description: Send based on conditions sendAsUser: type: string - type: object required: - targets - config - attachments properties: targets: type: array items: oneOf: - type: object required: - type - userId properties: type: type: string enum: - member userId: type: string description: '' title: User - type: object required: - type - teamId properties: type: type: string enum: - team teamId: type: string description: '' title: Team - type: object required: - type - email properties: type: type: string enum: - email email: type: string description: '' title: Email - type: object required: - type - slackConversationId properties: type: type: string enum: - slackChannel slackConversationId: type: string description: '' title: Slack channel - type: object required: - type - googleSpreadsheetUrl properties: type: type: string enum: - gsheet googleSpreadsheetUrl: type: string description: '' title: Google Sheets - type: object required: - type - googleDriveFolderUrl properties: type: type: string enum: - gdrive googleDriveFolderUrl: type: string description: '' title: Google Drive - type: object required: - type - cloudExport properties: type: type: string enum: - cloud-export cloudExport: oneOf: - type: object required: - bq properties: bq: type: object required: - bqDestination properties: bqDestination: type: string - type: object required: - sf properties: sf: type: object required: - sfDestination - authorization properties: sfDestination: type: string authorization: type: string - type: object required: - rs properties: rs: type: object required: - rsDestination - authorization properties: rsDestination: type: string authorization: type: string description: '' title: Cloud Storage - type: object required: - type - webhookUrl properties: type: type: string enum: - webhook webhookUrl: type: string description: '' title: Webhook - type: object required: - type - workbookCloudExport properties: type: type: string enum: - workbook-cloud-export workbookCloudExport: allOf: - oneOf: - type: object required: - connectionType - authorization properties: connectionType: type: string enum: - snowflake - redshift authorization: type: string - type: object required: - connectionType properties: connectionType: type: string enum: - bigQuery - type: object required: - uri - exportFormat - timestampedUri properties: uri: type: string exportFormat: type: string enum: - csv - csv.gzip timestampedUri: type: - string - 'null' description: '' title: Cloud Storage for a Workbook config: allOf: - type: object required: - title - messageBody properties: title: type: string messageBody: type: string - type: object properties: includeLink: type: boolean runAsRecipient: type: boolean rowLimit: type: number attachments: type: array items: type: object required: - formatOptions - source properties: formatOptions: oneOf: - type: object required: - type properties: type: type: string enum: - CSV - type: object required: - type properties: type: type: string enum: - JSON - type: object required: - type properties: type: type: string enum: - JSONL - type: object required: - type properties: type: type: string enum: - EXCEL - allOf: - type: object required: - type properties: type: type: string enum: - PDF - type: object properties: layout: type: string enum: - portrait - landscape scaleFactor: type: number - allOf: - type: object required: - type properties: type: type: string enum: - PNG - type: object properties: pixelWidth: type: - number - 'null' pixelHeight: type: - number - 'null' - type: object required: - type properties: type: type: string enum: - NONE source: oneOf: - type: object required: - type - elementId properties: type: type: string enum: - element elementId: type: string description: Export one element title: One element - type: object required: - type - pageId properties: type: type: string enum: - page pageId: type: string description: Export one page title: One page - type: object required: - type - nodeIds properties: type: type: string enum: - element nodeIds: type: array items: type: string description: Export multiple elements title: Multiple elements - type: object required: - type - nodeIds properties: type: type: string enum: - page nodeIds: type: array items: type: string description: Export multiple pages title: Multiple pages - type: object required: - type properties: type: type: string enum: - all description: Export all pages and elements in a workbook title: Entire workbook examples: Example request: value: targets: - type: email email: test@example.com config: title: My report messageBody: My report body includeLink: true runAsRecipient: true attachments: - formatOptions: type: PDF source: type: all responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/shareCrossOrg: post: summary: Share a workbook with another organization description: "Share a workbook or a template with another organization. Optionally share the associated datasets, if datasets (deprecated) are used as the source.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **templateId** by calling the [v2/templates](https://help.sigmacomputing.com/reference/list-templates) endpoint.\n- Retrieve the organization slug from the URL. Ask the recipient organization for the segment of their Sigma URL following `app.sigmacomputing.com`. For example, `app.sigmacomputing.com/sigma-docs` has an organization slug of `sigma-docs`.\n " parameters: - name: workbookId schema: type: string description: The unique identifier of the workbook or template. This ID is used to fetch, update, or delete specific workbook resources. title: Workbook ID in: path required: true operationId: shareWorkbookCrossOrg requestBody: description: The request body. content: application/json: schema: allOf: - type: object required: - orgSlugs properties: orgSlugs: type: array items: type: string description: The unique identifiers of the organizations to share the workbook with. title: Organization slug - type: object properties: shareDatasets: type: boolean description: Whether to share the datasets (deprecated) associated with the workbook. title: Share datasets copyInputTableData: type: boolean description: Whether to copy input table data to the recipient organization. title: Copy input table data sendEmail: type: boolean description: Whether to send an email to admins in the recipient org. title: Send email emailMessage: type: string description: The message to send to the recipients, if sendEmail is true. title: Email message responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/sources: get: summary: List workbook sources description: "Get the data sources of a workbook given the workbookId. The response can be a dataset (deprecated), table, custom SQL element, or the data model document and specific elements used as a source.\n\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: getWorkbookSources responses: '200': description: The response body. content: application/json: schema: type: array items: oneOf: - allOf: - type: object required: - type - dataModelId - elementIds properties: type: type: string enum: - data-model dataModelId: type: string elementIds: type: array items: type: string - type: object properties: versionTagId: type: string title: Data model source - type: object required: - type - inodeId - url properties: type: type: string enum: - dataset description: Dataset (deprecated) inodeId: type: string url: type: string description: URL to open this dataset in Sigma. title: Dataset source (deprecated) - type: object required: - type - inodeId properties: type: type: string enum: - table inodeId: type: string title: Table source - type: object required: - type - connectionId - definition - customSqlId properties: type: type: string enum: - custom-sql connectionId: type: string description: ID of the connection where the custom SQL element is run. definition: type: string description: Raw SQL definition for the custom SQL element. customSqlId: type: string description: Element ID of the custom SQL. title: Custom SQL element default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/spec: get: summary: Get the code representation of a workbook (Beta) description: 'This endpoint returns a code representation of a workbook, including metadata and contents. The response can be formatted as either JSON or YAML, and contains the workbook''s pages, elements, columns, sources, and more. The representation can be used to store, copy, or modify the workbook programmatically. **Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. For more information on managing workbooks programmatically, see [Manage workbooks as code](https://help.sigmacomputing.com/docs/manage-workbooks-as-code). For more information on using this endpoint, including end-to-end instructions, see [Get the code representation of a workbook](https://help.sigmacomputing.com/docs/get-the-code-representation-of-a-workbook). ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - The response includes references to the data sources and metadata necessary to recreate the workbook. The data itself is not included in the response. - To create a new workbook from code, use the [/v2/workbooks/spec](https://help.sigmacomputing.com/reference/create-workbook-spec) endpoint. - To update an existing workbook from code, use the [/v2/workbooks/{workbookId}/spec](https://help.sigmacomputing.com/reference/update-workbook-spec) endpoint. - The default format of the representation is YAML. To receive JSON, add the query parameter `?format=json` or the header `Accept: application/json`. ### Usage scenarios - **Backup and restore**: Developers can use this endpoint to programmatically back up workbooks and restore them if needed. - **Version control**: Developers can use this endpoint to programmatically manage, update, and version control workbooks between several organizations or tenants. ' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: documentVersion schema: type: integer in: query - name: format schema: oneOf: - type: string enum: - yaml - type: string enum: - yml - type: string enum: - json in: query operationId: getWorkbookSpec responses: '200': description: The response body. content: application/json: schema: allOf: - allOf: - type: object required: - workbookId properties: workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID - type: object required: - name - url - documentVersion - latestDocumentVersion - ownerId - folderId - createdBy - updatedBy - createdAt - updatedAt properties: name: type: string description: The name of the workbook. url: type: string description: The full URL for the requested document version of the workbook. documentVersion: type: number description: The document version of the workbook. latestDocumentVersion: type: number description: The most recently published document version of the workbook. ownerId: type: string description: The identifier of the user who owns the workbook. folderId: type: string description: The identifier of the folder in which the workbook is located. createdBy: type: string description: The identifier of the user who created the workbook. updatedBy: type: string description: The identifier of the user or process that last updated the workbook. createdAt: type: string format: date-time description: When the workbook was created. updatedAt: type: string format: date-time description: When the workbook was last updated. - type: object properties: description: type: string description: The description of the workbook. - allOf: - allOf: - type: object required: - schemaVersion properties: schemaVersion: type: number enum: - 1 description: The schema version used by this representation of the workbook. - type: object properties: kind: type: string enum: - workbook description: Document kind. Informational field, ignored when creating or updating a document. - type: object required: - pages properties: pages: type: array items: oneOf: - allOf: - type: object required: - id - type - name - elements properties: id: type: string description: The identifier of the modal page. type: type: string enum: - modal description: Marks this page as a modal. name: type: string description: The name of the modal. elements: type: array items: $ref: '#/components/schemas/WorkbookElement' description: The elements inside the modal. - type: object properties: modal: allOf: - type: object properties: width: oneOf: - type: string enum: - x-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large - type: string enum: - x-large description: 'Overlay width breakpoint: x-small, small, medium, large, or x-large.' header: type: object properties: title: type: string description: Header title. Supports dynamic-text {{formula}} references. showCloseIcon: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether the header shows the dismiss (X) icon: ''shown'' or ''hidden''.' description: 'Header configuration: title text and close-icon visibility.' - type: object properties: footer: type: object properties: primaryCta: type: object properties: visible: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether this CTA button is shown: ''shown'' or ''hidden''.' text: type: string description: CTA button label. Supports dynamic-text {{formula}} references. description: Primary footer CTA button. secondaryCta: type: object properties: visible: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether this CTA button is shown: ''shown'' or ''hidden''.' text: type: string description: CTA button label. Supports dynamic-text {{formula}} references. description: Secondary footer CTA button. description: Footer with primary/secondary CTA buttons. description: 'Modal presentation: width, header, and footer CTA buttons.' actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions fired by the modal (primary/secondary CTA click, or on close). backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional background image for the modal. Url supports dynamic-text {{formula}} references. title: Modal - allOf: - type: object required: - id - type - name - elements properties: id: type: string description: The identifier of the drawer page. type: type: string enum: - drawer description: Marks this page as a drawer. name: type: string description: The name of the drawer. elements: type: array items: $ref: '#/components/schemas/WorkbookElement' description: The elements inside the drawer. - type: object properties: drawer: allOf: - type: object properties: width: oneOf: - type: string enum: - x-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large - type: string enum: - x-large description: 'Overlay width breakpoint: x-small, small, medium, large, or x-large.' header: type: object properties: title: type: string description: Header title. Supports dynamic-text {{formula}} references. showCloseIcon: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether the header shows the dismiss (X) icon: ''shown'' or ''hidden''.' description: 'Header configuration: title text and close-icon visibility.' - type: object properties: position: oneOf: - type: string enum: - start - type: string enum: - end description: 'Which edge the drawer is anchored to: ''start'' (leading) or ''end'' (trailing).' showShadow: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether the dimming page overlay behind the drawer is shown: ''shown'' or ''hidden''.' description: 'Drawer presentation: width, header, anchor position, and page overlay.' actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions fired by the drawer (on close). backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional background image for the drawer. Url supports dynamic-text {{formula}} references. title: Drawer - allOf: - type: object required: - id - name - elements properties: id: type: string description: The identifier of the page in the data model. name: type: string description: The name of the page. elements: type: array items: $ref: '#/components/schemas/WorkbookElement' description: The elements on the page. - type: object properties: type: type: string enum: - page description: Marks this as a normal page. Defaults to 'page' when omitted. visibility: oneOf: - type: string enum: - hidden - type: object required: - kind - assignments properties: kind: type: string enum: - specific-users-and-teams assignments: type: object properties: users: type: array items: type: string description: The identifiers of the users allowed to view this page. teams: type: array items: type: string description: The identifiers of the teams allowed to view this page. description: The users and teams allowed to view this page, each by opaque id. An empty allowlist (both arrays omitted) is permitted. description: 'Page visibility. Set to `''hidden''` to hide the page from end users, or `{ kind: ''specific-users-and-teams'', assignments: { users: [...], teams: [...] } }` to restrict it to specific users/teams. Omit for a page visible to all users.' backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional page-level background image. Url supports dynamic-text {{formula}} references. title: Page description: The pages of the workbook spec and their contents. - type: object properties: themeName: oneOf: - oneOf: - type: string enum: - Light - type: string enum: - Dark - type: string enum: - Surface - type: string description: Built-in theme name (`Light`, `Dark`, `Surface`) or org theme UUID. themeOverrides: type: object properties: borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' categoricalScheme: oneOf: - type: string - type: array items: type: string description: Categorical color palette name or custom hex array. colorOverrides: type: object additionalProperties: type: string description: Per-token layout color overrides (hex). Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground). colors: type: object properties: text: type: string description: Primary text color (hex). highlight: type: string description: Highlight / accent color (hex). Maps to theme `$primary`. surface: type: string description: Surface color (hex). success: type: string description: Success color (hex). warning: type: string description: Warning color (hex). danger: type: string description: Danger color (hex). darkMode: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Dark color mode: ''shown'' or ''hidden''.' divergingScheme: type: string description: Named diverging color scheme. elementBorder: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' width: type: number description: Element border width in pixels (0–3). fonts: type: object properties: dataFont: type: string description: 'Data font family name (format panel: Data font).' textFont: type: string description: 'Text font family name (format panel: Text font).' hasCards: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Card-style element chrome: ''shown'' or ''hidden''.' invertTooltipColors: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Invert tooltip colors: ''shown'' or ''hidden''.' layoutColors: type: object properties: useElementForeground: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Render elements above the canvas: ''shown'' or ''hidden''.' maxPageWidth: type: number description: Max page width in pixels when pageWidth is custom (minimum 600). pageWidth: oneOf: - type: string enum: - full - type: string enum: - large - type: string enum: - medium - type: string enum: - custom description: 'Page content width: ''full'', ''large'', ''medium'', or ''custom''.' sequentialScheme: type: string description: Named sequential color scheme. space: type: object properties: showElementPadding: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Show padding around elements: ''shown'' or ''hidden''.' unit: oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Element spacing (format panel: Spacing): ''small'', ''medium'', or ''large''.' tableStyles: type: object properties: preset: oneOf: - type: string enum: - spreadsheet - type: string enum: - presentation description: 'Table preset: ''spreadsheet'' or ''presentation''. Omit when spreadsheet (default).' cellSpacing: oneOf: - type: string enum: - extra-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Cell spacing preset: ''extra-small'', ''small'', ''medium'', or ''large''.' gridLines: oneOf: - type: string enum: - none - type: string enum: - vertical - type: string enum: - horizontal - type: string enum: - all description: 'Grid lines: ''none'', ''vertical'', ''horizontal'', or ''all''.' banding: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Row banding visibility: ''shown'' or ''hidden''.' bandingColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' autofitColumns: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Autofit column widths (level table only): ''shown'' or ''hidden''.' outerBorder: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Outer table border: ''shown'' or ''hidden''. Maps to inverted store `hideOuterBorder`.' headerDividerColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' heavyVerticalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier vertical group dividers (pivot only): ''shown'' or ''hidden''.' heavyHorizontalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier horizontal group dividers (pivot only): ''shown'' or ''hidden''.' textStyles: type: object properties: header: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' cell: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' columnHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' rowHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' titleFont: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Title font size in pixels (6–96). fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold - type: object properties: agents: type: array items: allOf: - type: object required: - id - instructions properties: id: type: string description: The identifier of the agent. instructions: type: string description: Instructions that guide the agent. Use {{formula}} for dynamic values, @dataSource("elementId") for configured data sources, and @tool("toolId") for configured tools. - type: object properties: name: type: string description: Display name for the agent. description: type: string description: Description of the agent. greeting: oneOf: - type: object required: - mode - message properties: mode: type: string enum: - static message: type: string description: The exact first message the assistant shows when the chat opens. Supports `{{formula}}` references. description: '' title: Fixed greeting - type: object required: - mode - prompt properties: mode: type: string enum: - generated prompt: type: string description: A prompt the agent runs to generate its first message when the chat opens. Supports `{{formula}}` references. description: '' title: Generated greeting description: The message a chat backed by this agent opens with. Omit for the default greeting. dataSources: type: array items: type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The ID of a workbook element (table or chart) the agent can read from. description: '' title: Workbook element description: Data sources that the agent can access, such as data model tables or workbook data elements. tools: type: array items: oneOf: - type: object required: - toolId - kind - connectorId - name properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - mcp-connector connectorId: type: string description: The UUID of the MCP connector. name: type: string description: The display name of the MCP connector. description: '' title: MCP connector - allOf: - type: object required: - toolId - kind properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - warehouse-agent - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object properties: description: type: string description: A description of when the agent should invoke this warehouse agent. description: '' title: Warehouse agent - allOf: - type: object required: - toolId - kind - description properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - search-service description: type: string description: A description of the content the search service can retrieve. - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. description: '' title: Search service - allOf: - type: object required: - toolId - kind - name - description - steps properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - action name: type: string description: The display name of the action tool. description: type: string description: What this tool does and when the agent should invoke it. steps: type: array items: oneOf: - allOf: - type: object required: - kind - sequenceId properties: kind: type: string enum: - sequence sequenceId: type: string description: Identifier for a workbook action sequence. - type: object properties: name: type: string description: Optional display name for this step. description: '' title: Sequence reference - allOf: - type: object required: - kind properties: kind: type: string enum: - effect - oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab - type: object properties: name: type: string description: Optional display name for this step. description: An action effect to run directly. Effects that depend on a user's element interaction, such as a selected row or column, are not supported. title: Inline effect description: Ordered steps the agent runs when it invokes this tool. - type: object properties: requiresApproval: type: boolean description: Whether the agent must get user approval before running this tool. description: '' title: Action description: Tools the agent can invoke. description: Workbook-level agents. Reference one from a chat element via `agentId`. - type: object required: - layout properties: layout: oneOf: - type: string - type: 'null' default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] put: summary: Update a workbook from a code representation (Beta) description: 'This endpoint replaces a workbook with a workbook defined in a code representation. You can programmatically update the workbook''s structure, metadata, and contents. This creates a new version of the workbook, which is accessible from the Sigma UI. **Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### System and user requirements - To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish workbooks** permission. - To perform this operation, you must use API credentials owned by a user with **Can edit** access for the workbook. ### Usage notes - The default format of the representation is YAML. To use JSON, add the header `Content-Type: application/json`. - You can define the layout of contents on the workbook page using XML in the `layout` field. For more information, see [Customize the layout of a workbook in code representation](https://help.sigmacomputing.com/docs/customize-the-layout-of-a-workbook-in-code-representation). - You can combine multiple YAML documents to create one workbook representation. For more information, see [Prepare a representation from multiple YAML documents](https://help.sigmacomputing.com/docs/create-a-workbook-from-a-code-representation#prepare-a-representation-from-multiple-yaml-documents). - To retrieve the representation of an existing workbook, use the [/v2/workbooks/{workbookId}/spec](https://help.sigmacomputing.com/reference/get-workbook-spec) endpoint. - To create a new workbook from code, use the [/v2/workbooks/spec](https://help.sigmacomputing.com/reference/create-workbook-spec) endpoint. - The endpoint only supports updates to the `pages` array and its contents. Additional fields are not required and are ignored in the request body. - Partial updates are not supported. You must provide the entire representation of the workbook in the request body. ### Usage scenarios - **Agentic workflows**: Agents can use these endpoints to directly manage workbook contents in code. - **Automation**: If you want to update several workbooks across one or more organizations, or in response to external events, you can use this endpoint to programmatically update the workbooks. - **Integration**: Using this endpoint, you can update workbooks based on external data sources or integrate Sigma with other tools and platforms. ' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: updateWorkbookSpec requestBody: description: The request body. content: application/json: schema: allOf: - allOf: - type: object required: - schemaVersion properties: schemaVersion: type: number enum: - 1 description: The schema version used by this representation of the workbook. - type: object properties: kind: type: string enum: - workbook description: Document kind. Informational field, ignored when creating or updating a document. - type: object required: - pages properties: pages: type: array items: oneOf: - allOf: - type: object required: - id - type - name - elements properties: id: type: string description: The identifier of the modal page. type: type: string enum: - modal description: Marks this page as a modal. name: type: string description: The name of the modal. elements: type: array items: $ref: '#/components/schemas/WorkbookElement' description: The elements inside the modal. - type: object properties: modal: allOf: - type: object properties: width: oneOf: - type: string enum: - x-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large - type: string enum: - x-large description: 'Overlay width breakpoint: x-small, small, medium, large, or x-large.' header: type: object properties: title: type: string description: Header title. Supports dynamic-text {{formula}} references. showCloseIcon: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether the header shows the dismiss (X) icon: ''shown'' or ''hidden''.' description: 'Header configuration: title text and close-icon visibility.' - type: object properties: footer: type: object properties: primaryCta: type: object properties: visible: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether this CTA button is shown: ''shown'' or ''hidden''.' text: type: string description: CTA button label. Supports dynamic-text {{formula}} references. description: Primary footer CTA button. secondaryCta: type: object properties: visible: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether this CTA button is shown: ''shown'' or ''hidden''.' text: type: string description: CTA button label. Supports dynamic-text {{formula}} references. description: Secondary footer CTA button. description: Footer with primary/secondary CTA buttons. description: 'Modal presentation: width, header, and footer CTA buttons.' actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions fired by the modal (primary/secondary CTA click, or on close). backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional background image for the modal. Url supports dynamic-text {{formula}} references. title: Modal - allOf: - type: object required: - id - type - name - elements properties: id: type: string description: The identifier of the drawer page. type: type: string enum: - drawer description: Marks this page as a drawer. name: type: string description: The name of the drawer. elements: type: array items: $ref: '#/components/schemas/WorkbookElement' description: The elements inside the drawer. - type: object properties: drawer: allOf: - type: object properties: width: oneOf: - type: string enum: - x-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large - type: string enum: - x-large description: 'Overlay width breakpoint: x-small, small, medium, large, or x-large.' header: type: object properties: title: type: string description: Header title. Supports dynamic-text {{formula}} references. showCloseIcon: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether the header shows the dismiss (X) icon: ''shown'' or ''hidden''.' description: 'Header configuration: title text and close-icon visibility.' - type: object properties: position: oneOf: - type: string enum: - start - type: string enum: - end description: 'Which edge the drawer is anchored to: ''start'' (leading) or ''end'' (trailing).' showShadow: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether the dimming page overlay behind the drawer is shown: ''shown'' or ''hidden''.' description: 'Drawer presentation: width, header, anchor position, and page overlay.' actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions fired by the drawer (on close). backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional background image for the drawer. Url supports dynamic-text {{formula}} references. title: Drawer - allOf: - type: object required: - id - name - elements properties: id: type: string description: The identifier of the page in the data model. name: type: string description: The name of the page. elements: type: array items: $ref: '#/components/schemas/WorkbookElement' description: The elements on the page. - type: object properties: type: type: string enum: - page description: Marks this as a normal page. Defaults to 'page' when omitted. visibility: oneOf: - type: string enum: - hidden - type: object required: - kind - assignments properties: kind: type: string enum: - specific-users-and-teams assignments: type: object properties: users: type: array items: type: string description: The identifiers of the users allowed to view this page. teams: type: array items: type: string description: The identifiers of the teams allowed to view this page. description: The users and teams allowed to view this page, each by opaque id. An empty allowlist (both arrays omitted) is permitted. description: 'Page visibility. Set to `''hidden''` to hide the page from end users, or `{ kind: ''specific-users-and-teams'', assignments: { users: [...], teams: [...] } }` to restrict it to specific users/teams. Omit for a page visible to all users.' backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional page-level background image. Url supports dynamic-text {{formula}} references. title: Page description: The pages of the workbook spec and their contents. - type: object properties: themeName: oneOf: - oneOf: - type: string enum: - Light - type: string enum: - Dark - type: string enum: - Surface - type: string description: Built-in theme name (`Light`, `Dark`, `Surface`) or org theme UUID. themeOverrides: type: object properties: borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' categoricalScheme: oneOf: - type: string - type: array items: type: string description: Categorical color palette name or custom hex array. colorOverrides: type: object additionalProperties: type: string description: Per-token layout color overrides (hex). Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground). colors: type: object properties: text: type: string description: Primary text color (hex). highlight: type: string description: Highlight / accent color (hex). Maps to theme `$primary`. surface: type: string description: Surface color (hex). success: type: string description: Success color (hex). warning: type: string description: Warning color (hex). danger: type: string description: Danger color (hex). darkMode: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Dark color mode: ''shown'' or ''hidden''.' divergingScheme: type: string description: Named diverging color scheme. elementBorder: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' width: type: number description: Element border width in pixels (0–3). fonts: type: object properties: dataFont: type: string description: 'Data font family name (format panel: Data font).' textFont: type: string description: 'Text font family name (format panel: Text font).' hasCards: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Card-style element chrome: ''shown'' or ''hidden''.' invertTooltipColors: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Invert tooltip colors: ''shown'' or ''hidden''.' layoutColors: type: object properties: useElementForeground: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Render elements above the canvas: ''shown'' or ''hidden''.' maxPageWidth: type: number description: Max page width in pixels when pageWidth is custom (minimum 600). pageWidth: oneOf: - type: string enum: - full - type: string enum: - large - type: string enum: - medium - type: string enum: - custom description: 'Page content width: ''full'', ''large'', ''medium'', or ''custom''.' sequentialScheme: type: string description: Named sequential color scheme. space: type: object properties: showElementPadding: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Show padding around elements: ''shown'' or ''hidden''.' unit: oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Element spacing (format panel: Spacing): ''small'', ''medium'', or ''large''.' tableStyles: type: object properties: preset: oneOf: - type: string enum: - spreadsheet - type: string enum: - presentation description: 'Table preset: ''spreadsheet'' or ''presentation''. Omit when spreadsheet (default).' cellSpacing: oneOf: - type: string enum: - extra-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Cell spacing preset: ''extra-small'', ''small'', ''medium'', or ''large''.' gridLines: oneOf: - type: string enum: - none - type: string enum: - vertical - type: string enum: - horizontal - type: string enum: - all description: 'Grid lines: ''none'', ''vertical'', ''horizontal'', or ''all''.' banding: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Row banding visibility: ''shown'' or ''hidden''.' bandingColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' autofitColumns: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Autofit column widths (level table only): ''shown'' or ''hidden''.' outerBorder: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Outer table border: ''shown'' or ''hidden''. Maps to inverted store `hideOuterBorder`.' headerDividerColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' heavyVerticalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier vertical group dividers (pivot only): ''shown'' or ''hidden''.' heavyHorizontalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier horizontal group dividers (pivot only): ''shown'' or ''hidden''.' textStyles: type: object properties: header: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' cell: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' columnHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' rowHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' titleFont: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Title font size in pixels (6–96). fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold - type: object properties: agents: type: array items: allOf: - type: object required: - id - instructions properties: id: type: string description: The identifier of the agent. instructions: type: string description: Instructions that guide the agent. Use {{formula}} for dynamic values, @dataSource("elementId") for configured data sources, and @tool("toolId") for configured tools. - type: object properties: name: type: string description: Display name for the agent. description: type: string description: Description of the agent. greeting: oneOf: - type: object required: - mode - message properties: mode: type: string enum: - static message: type: string description: The exact first message the assistant shows when the chat opens. Supports `{{formula}}` references. description: '' title: Fixed greeting - type: object required: - mode - prompt properties: mode: type: string enum: - generated prompt: type: string description: A prompt the agent runs to generate its first message when the chat opens. Supports `{{formula}}` references. description: '' title: Generated greeting description: The message a chat backed by this agent opens with. Omit for the default greeting. dataSources: type: array items: type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The ID of a workbook element (table or chart) the agent can read from. description: '' title: Workbook element description: Data sources that the agent can access, such as data model tables or workbook data elements. tools: type: array items: oneOf: - type: object required: - toolId - kind - connectorId - name properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - mcp-connector connectorId: type: string description: The UUID of the MCP connector. name: type: string description: The display name of the MCP connector. description: '' title: MCP connector - allOf: - type: object required: - toolId - kind properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - warehouse-agent - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object properties: description: type: string description: A description of when the agent should invoke this warehouse agent. description: '' title: Warehouse agent - allOf: - type: object required: - toolId - kind - description properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - search-service description: type: string description: A description of the content the search service can retrieve. - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. description: '' title: Search service - allOf: - type: object required: - toolId - kind - name - description - steps properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - action name: type: string description: The display name of the action tool. description: type: string description: What this tool does and when the agent should invoke it. steps: type: array items: oneOf: - allOf: - type: object required: - kind - sequenceId properties: kind: type: string enum: - sequence sequenceId: type: string description: Identifier for a workbook action sequence. - type: object properties: name: type: string description: Optional display name for this step. description: '' title: Sequence reference - allOf: - type: object required: - kind properties: kind: type: string enum: - effect - oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab - type: object properties: name: type: string description: Optional display name for this step. description: An action effect to run directly. Effects that depend on a user's element interaction, such as a selected row or column, are not supported. title: Inline effect description: Ordered steps the agent runs when it invokes this tool. - type: object properties: requiresApproval: type: boolean description: Whether the agent must get user approval before running this tool. description: '' title: Action description: Tools the agent can invoke. description: Workbook-level agents. Reference one from a chat element via `agentId`. - type: object properties: layout: oneOf: - type: string - type: 'null' description: Grid layout as XML. title: Layout XML responses: '200': description: The response body. content: application/json: schema: type: object required: - success - workbookId properties: success: type: boolean workbookId: type: string default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/swapSources: post: summary: Swap workbook data sources description: "Swap the data sources used by a workbook. You can swap from one connection to another, and/or from one dataset or table to another.\n\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n - Retrieve the sources used by a workbook from the [v2/workbooks/{workbookId}/sources](https://help.sigmacomputing.com/reference/get-workbook-sources) endpoint.\n\n - To swap all tables in a connection, set the `swapTables` option to `true`.\n\n - Use the `paths` option to specify the connection paths to swap. The connection path is a list of strings that represents the path to the table in the cloud data warehouse. For example, `[\"database\", \"schema\", \"table\"]`.\n - If the table schema is the same in both connections, leave the `paths` option empty to swap all tables in the connection. You can also pass a partial path to swap between databases, catalogs, or schemas.\n - If `sourceMapping` is provided, those mappings take precedence over the connection swaps.\n - If `swapTables` is not set to `true`, only Custom SQL elements have their connections changed.\n\n ### Usage scenarios\n - **Workbook development**: Use a test data source while developing a workbook, then swap the source to a production database when ready to share the workbook for production use.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: sourceSwapWorkbook requestBody: description: The request body. content: application/json: schema: type: object properties: sourceMapping: type: array items: allOf: - type: object required: - fromId - toId properties: fromId: type: string description: ID of the dataset (deprecated) or table to swap from. title: Data source ID toId: type: string description: ID of the dataset (deprecated) or table to swap to. title: Data source ID - type: object properties: metricMapping: type: array items: type: object required: - fromMetric - toMetric properties: fromMetric: type: string description: Metric in the data source. title: Metric name toMetric: type: string description: Metric in the data source. title: Metric name columnMapping: type: array items: type: object required: - fromColumn - toColumn properties: fromColumn: oneOf: - type: string description: Column in the data source. title: Column name - type: array items: type: string description: Dataset or table link of the form ["link_name", "column_name"] title: Link toColumn: oneOf: - type: string description: Column in the data source. title: Column name - type: array items: type: string description: Dataset or table link of the form ["link_name", "column_name"] title: Link connectionMapping: type: array items: allOf: - type: object required: - fromId - toId properties: fromId: type: string description: ID of the connection to swap from. title: Connection ID toId: type: string description: ID of the connection to swap to. title: Connection ID - type: object properties: swapTables: type: boolean description: Whether to swap all tables in the connection title: Swap Tables paths: type: array items: type: object required: - fromPath - toPath properties: fromPath: type: array items: type: string description: Connection path of the form ['DATABASE', 'SCHEMA', 'TABLE'] title: From Path toPath: type: array items: type: string description: Connection path of the form ['DATABASE', 'SCHEMA', 'TABLE'] title: To Path copyInputTableData: type: boolean responses: '200': description: The response body. content: application/json: schema: type: object required: - unswappedSources - unswappedConnections properties: unswappedSources: type: array items: type: string description: IDs of sources in the workbook that were not swapped. unswappedConnections: type: array items: type: string description: IDs of custom SQL connections in the workbook that were not swapped. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/tag/{versionTag}/copy: post: summary: Duplicate a tagged workbook description: "This endpoint lets you duplicate a tagged workbook, creating a new workbook from the tagged version. The workbook copy can be placed in a different folder from the original workbook, potentially with a different name and description. This is useful for creating workbook templates or backups.\n### Usage notes\n- The workbookId and version tag in the URL specify the tagged version of the workbook to duplicate. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. For the **versionTag**, you can specify either the tag name or ID. Retrieve the version tag name or ID by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint.\n- The `destinationFolderId` in the request body specifies where to place the new workbook.\n - To use the \"My Documents\" folder for a specific user as the destination folder, call the [/v2/members/{memberId}](https://help.sigmacomputing.com/reference/get-member) endpoint and use the `homeFolderId` included in the response.\n - Retrieve the **folderId** of all folders by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`.\n### Best practices\n- Always verify that the destination folder has the correct permissions set to avoid access issues." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: versionTag schema: type: string description: The id or name of the version tag to use. title: versionTag in: path required: true operationId: copyTaggedWorkbook requestBody: description: The request body. content: application/json: schema: allOf: - type: object required: - destinationFolderId - name properties: destinationFolderId: type: string description: ID of the folder in which to place the copied workbook. title: Destination Folder ID name: type: string description: Name for the copied workbook as it appears in Sigma. title: New Workbook Name - type: object properties: description: type: string description: A description for the new workbook. title: New Description copyBookmarks: type: string enum: - all - accessible description: If set to `all` (available to admins only), every saved view (bookmark) applied to the workbook is copied. If set to `accessible`, only personal saved views and those shared with the user initiating the operation are copied. Ownership of all saved views in the duplicate workbook transfers to the user initiating the operation. If not set, saved views are not copied. title: Copy Bookmarks description: Body parameters for copying a workbook. responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - workbookId - workbookUrlId - name - url - path - latestVersion - ownerId properties: workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID workbookUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number ownerId: type: string - type: object required: - createdBy - updatedBy - createdAt - updatedAt properties: createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. - type: object properties: isArchived: type: boolean tags: type: array items: type: object required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt properties: versionTagId: type: string description: Unique identifier of the tag. title: Tag ID name: type: string sourceWorkbookVersion: type: number taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. title: Workbook ID workbookTaggedAt: type: string format: date-time description: type: string default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/tags: get: summary: Get tags for a workbook description: "Retrieve the version tag information for a workbook. Returns the same tag metadata as the [GET /v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint returns for a tagged workbook.\n ### Usage notes\n - Use this endpoint to provide on-demand access to version tag information for a workbook. For example, call the [GET /v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint with the \"excludeTags\" parameter set to `True` to improve performance, then use this endpoint to return tag information for specific workbooks." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: getWorkbookTags responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: type: object required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt properties: versionTagId: type: string description: Unique identifier of the tag. title: Tag ID name: type: string sourceWorkbookVersion: type: number taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. title: Workbook ID workbookTaggedAt: type: string format: date-time nextPage: type: - string - 'null' - type: object properties: total: type: number default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/tags/{tagId}: delete: summary: Remove a tag from a workbook description: "This endpoint removes a specific version tag from a workbook. Version tags are used to mark workbooks for certain stages or characteristics. Removing a version tag can help manage and update the organizational scheme of workbooks as projects evolve or conclude.\n\n ### Usage notes\n - **workbookId:** The unique identifier for the workbook to remove the tag from. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - **tagId:** The unique identifier for the tag to remove. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response.\n\n ### Usage scenarios\n - **Organizational updates:** Useful for administrators who need to update tagging schemes as project requirements change.\n - **Data management:** Helps in maintaining the relevance and organization of workbook metadata for easier access and identification.\n\n ### Best practices\n - Verify that the correct tag is being removed by reviewing its associated workbooks and the implications of its removal." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: tagId schema: type: string description: Unique identifier of the version tag title: tagId in: path required: true operationId: deleteTaggedworkbook responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks: get: summary: List bookmarks in a tagged workbook description: "Returns a list of bookmarks in a tagged workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **tagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: tagName schema: type: string in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: getTaggedWorkbookBookmarks responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: allOf: - type: object required: - bookmarkId - name - isShared - exploreKey properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. - type: object properties: isDefault: type: boolean description: Whether the bookmark is default. nextPage: type: - string - 'null' - type: object properties: total: type: number default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks/: post: summary: Add a bookmark to a tagged workbook description: "Add a bookmark to a version tagged workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **tagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n- Retrieve the **workbookVersion** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `latestVersion` in the response for the workbook, or from the version history **More** menu for the specific version.\n- Retrieve the **exploreKey** by identifying the ID of the workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: tagName schema: type: string in: path required: true operationId: createTaggedWorkbookBookmark requestBody: description: The request body. content: application/json: schema: type: object required: - workbookVersion - name - isShared - exploreKey properties: workbookVersion: type: number name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - bookmarkId - name - isShared - exploreKey properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. - type: object properties: isDefault: type: boolean description: Whether the bookmark is default. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/tags/{tagName}/bookmarks/{bookmarkId}: get: summary: Get a bookmark in a tagged workbook description: "Retrieve details for a bookmark in a tagged workbook based on bookmarkId\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **tagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n- Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: tagName schema: type: string in: path required: true - name: bookmarkId schema: type: string description: Unique identifier of the bookmark. title: Bookmark ID in: path required: true operationId: getTaggedWorkbookBookmark responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - bookmarkId - name - isShared - exploreKey properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. - type: object properties: isDefault: type: boolean description: Whether the bookmark is default. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] patch: summary: Update a bookmark in a tagged workbook description: "Update a bookmark in a version tagged workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **tagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n- Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.\n- Retrieve the **workbookVersion** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint and using the `latestVersion` in the response for the workbook, or from the version history **More** menu for the specific version.\n- Retrieve the **exploreKey** by identifying the ID of the workbook exploration that you want to bookmark. When exploring a workbook, the explore ID is visible in the URL: `:explore=76c76e52-8d94-448a-969c-32cc18da9ea0`. Provide the ID after the `=`.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: tagName schema: type: string in: path required: true - name: bookmarkId schema: type: string in: path required: true operationId: updateTaggedWorkbookBookmark requestBody: description: The request body. content: application/json: schema: type: object properties: name: type: - string - 'null' isShared: type: - boolean - 'null' isDefault: type: - boolean - 'null' exploreKey: type: - string - 'null' description: ID of the associated exploration. responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - bookmarkId - name - isShared - exploreKey properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. - type: object properties: isDefault: type: boolean description: Whether the bookmark is default. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] delete: summary: Delete a bookmark from a tagged workbook description: "Delete a bookmark from a version tagged workbook.\n\n### Usage notes\n- Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- Retrieve the **tagName** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n- Retrieve the **bookmarkId** by calling the [/v2/workbooks/{workbookId}/bookmarks](https://help.sigmacomputing.com/reference/get-workbook-bookmarks) endpoint.\n " parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: tagName schema: type: string in: path required: true - name: bookmarkId schema: type: string description: Unique identifier of the bookmark. title: Bookmark ID in: path required: true operationId: deleteTaggedWorkbookBookmark responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/{workbookId}/version-history: get: summary: Get version history for a workbook description: Get version history for a workbook given the workbookId. If the version history contains any tagged versions, the response includes information about the version tag. parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: getVersionHistory responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: allOf: - type: object required: - version - publishedAt - publishedBy properties: version: type: number publishedAt: type: string format: date-time publishedBy: type: string - type: object properties: tags: type: array items: type: object required: - versionTagId - taggedAt - taggedBy properties: versionTagId: type: string taggedAt: type: string format: date-time taggedBy: type: string nextPage: type: - string - 'null' - type: object properties: total: type: number default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/spec: post: summary: Create a workbook from a code representation (Beta) description: 'This endpoint creates a new workbook from a code representation. Use it to programmatically define and create workbooks that are then accessible from the Sigma UI. **Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. For more information on managing workbooks programmatically, see [Manage workbooks as code](https://help.sigmacomputing.com/docs/manage-workbooks-as-code). For more information on using this endpoint, including end-to-end instructions, see [Create a workbook from a code representation](https://help.sigmacomputing.com/docs/create-a-workbook-from-a-code-representation). ### System and user requirements - To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish workbooks** permission. - To perform this operation, you must use API credentials owned by a user with **Can edit** access for the workbook. ### Usage notes - You can define the layout of contents on the workbook page using XML in the `layout` field. For more information, see [Customize the layout of a workbook in code representation](https://help.sigmacomputing.com/docs/customize-the-layout-of-a-workbook-in-code-representation). - You can combine multiple YAML documents to create one workbook representation. For more information, see [Prepare a representation from multiple YAML documents](https://help.sigmacomputing.com/docs/create-a-workbook-from-a-code-representation#prepare-a-representation-from-multiple-yaml-documents). - To retrieve the representation of an existing workbook, use the [/v2/workbooks/{workbookId}/spec](https://help.sigmacomputing.com/reference/get-workbook-spec) endpoint. - To update an existing workbook from code, use the [/v2/workbooks/{workbookId}/spec](https://help.sigmacomputing.com/reference/update-workbook-spec) endpoint. - To get a list of folders, call the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and review the `id` field in the response for files with a `type` of `folder`. ### Usage scenarios - **Agentic workflows**: Agents can use these endpoints to directly manage workbook contents in code. - **Automation**: If you want to create several workbooks across one or more organizations, you can use this endpoint to programmatically create the workbooks. - **Integration**: Using this endpoint, you can create workbooks based on external data sources or integrate Sigma with other tools and platforms. - **Migration**: You can use this endpoint to migrate workbooks from one organization to another. ' parameters: [] operationId: createWorkbookSpec requestBody: description: The request body. content: application/json: schema: allOf: - type: object required: - name - folderId properties: name: type: string description: The name of the workbook. folderId: type: string description: The identifier of the folder in which the workbook is located. - allOf: - allOf: - type: object required: - schemaVersion properties: schemaVersion: type: number enum: - 1 description: The schema version used by this representation of the workbook. - type: object properties: kind: type: string enum: - workbook description: Document kind. Informational field, ignored when creating or updating a document. - type: object required: - pages properties: pages: type: array items: oneOf: - allOf: - type: object required: - id - type - name - elements properties: id: type: string description: The identifier of the modal page. type: type: string enum: - modal description: Marks this page as a modal. name: type: string description: The name of the modal. elements: type: array items: $ref: '#/components/schemas/WorkbookElement' description: The elements inside the modal. - type: object properties: modal: allOf: - type: object properties: width: oneOf: - type: string enum: - x-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large - type: string enum: - x-large description: 'Overlay width breakpoint: x-small, small, medium, large, or x-large.' header: type: object properties: title: type: string description: Header title. Supports dynamic-text {{formula}} references. showCloseIcon: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether the header shows the dismiss (X) icon: ''shown'' or ''hidden''.' description: 'Header configuration: title text and close-icon visibility.' - type: object properties: footer: type: object properties: primaryCta: type: object properties: visible: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether this CTA button is shown: ''shown'' or ''hidden''.' text: type: string description: CTA button label. Supports dynamic-text {{formula}} references. description: Primary footer CTA button. secondaryCta: type: object properties: visible: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether this CTA button is shown: ''shown'' or ''hidden''.' text: type: string description: CTA button label. Supports dynamic-text {{formula}} references. description: Secondary footer CTA button. description: Footer with primary/secondary CTA buttons. description: 'Modal presentation: width, header, and footer CTA buttons.' actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions fired by the modal (primary/secondary CTA click, or on close). backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional background image for the modal. Url supports dynamic-text {{formula}} references. title: Modal - allOf: - type: object required: - id - type - name - elements properties: id: type: string description: The identifier of the drawer page. type: type: string enum: - drawer description: Marks this page as a drawer. name: type: string description: The name of the drawer. elements: type: array items: $ref: '#/components/schemas/WorkbookElement' description: The elements inside the drawer. - type: object properties: drawer: allOf: - type: object properties: width: oneOf: - type: string enum: - x-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large - type: string enum: - x-large description: 'Overlay width breakpoint: x-small, small, medium, large, or x-large.' header: type: object properties: title: type: string description: Header title. Supports dynamic-text {{formula}} references. showCloseIcon: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether the header shows the dismiss (X) icon: ''shown'' or ''hidden''.' description: 'Header configuration: title text and close-icon visibility.' - type: object properties: position: oneOf: - type: string enum: - start - type: string enum: - end description: 'Which edge the drawer is anchored to: ''start'' (leading) or ''end'' (trailing).' showShadow: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether the dimming page overlay behind the drawer is shown: ''shown'' or ''hidden''.' description: 'Drawer presentation: width, header, anchor position, and page overlay.' actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions fired by the drawer (on close). backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional background image for the drawer. Url supports dynamic-text {{formula}} references. title: Drawer - allOf: - type: object required: - id - name - elements properties: id: type: string description: The identifier of the page in the data model. name: type: string description: The name of the page. elements: type: array items: $ref: '#/components/schemas/WorkbookElement' description: The elements on the page. - type: object properties: type: type: string enum: - page description: Marks this as a normal page. Defaults to 'page' when omitted. visibility: oneOf: - type: string enum: - hidden - type: object required: - kind - assignments properties: kind: type: string enum: - specific-users-and-teams assignments: type: object properties: users: type: array items: type: string description: The identifiers of the users allowed to view this page. teams: type: array items: type: string description: The identifiers of the teams allowed to view this page. description: The users and teams allowed to view this page, each by opaque id. An empty allowlist (both arrays omitted) is permitted. description: 'Page visibility. Set to `''hidden''` to hide the page from end users, or `{ kind: ''specific-users-and-teams'', assignments: { users: [...], teams: [...] } }` to restrict it to specific users/teams. Omit for a page visible to all users.' backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional page-level background image. Url supports dynamic-text {{formula}} references. title: Page description: The pages of the workbook spec and their contents. - type: object properties: themeName: oneOf: - oneOf: - type: string enum: - Light - type: string enum: - Dark - type: string enum: - Surface - type: string description: Built-in theme name (`Light`, `Dark`, `Surface`) or org theme UUID. themeOverrides: type: object properties: borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' categoricalScheme: oneOf: - type: string - type: array items: type: string description: Categorical color palette name or custom hex array. colorOverrides: type: object additionalProperties: type: string description: Per-token layout color overrides (hex). Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground). colors: type: object properties: text: type: string description: Primary text color (hex). highlight: type: string description: Highlight / accent color (hex). Maps to theme `$primary`. surface: type: string description: Surface color (hex). success: type: string description: Success color (hex). warning: type: string description: Warning color (hex). danger: type: string description: Danger color (hex). darkMode: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Dark color mode: ''shown'' or ''hidden''.' divergingScheme: type: string description: Named diverging color scheme. elementBorder: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' width: type: number description: Element border width in pixels (0–3). fonts: type: object properties: dataFont: type: string description: 'Data font family name (format panel: Data font).' textFont: type: string description: 'Text font family name (format panel: Text font).' hasCards: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Card-style element chrome: ''shown'' or ''hidden''.' invertTooltipColors: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Invert tooltip colors: ''shown'' or ''hidden''.' layoutColors: type: object properties: useElementForeground: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Render elements above the canvas: ''shown'' or ''hidden''.' maxPageWidth: type: number description: Max page width in pixels when pageWidth is custom (minimum 600). pageWidth: oneOf: - type: string enum: - full - type: string enum: - large - type: string enum: - medium - type: string enum: - custom description: 'Page content width: ''full'', ''large'', ''medium'', or ''custom''.' sequentialScheme: type: string description: Named sequential color scheme. space: type: object properties: showElementPadding: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Show padding around elements: ''shown'' or ''hidden''.' unit: oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Element spacing (format panel: Spacing): ''small'', ''medium'', or ''large''.' tableStyles: type: object properties: preset: oneOf: - type: string enum: - spreadsheet - type: string enum: - presentation description: 'Table preset: ''spreadsheet'' or ''presentation''. Omit when spreadsheet (default).' cellSpacing: oneOf: - type: string enum: - extra-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Cell spacing preset: ''extra-small'', ''small'', ''medium'', or ''large''.' gridLines: oneOf: - type: string enum: - none - type: string enum: - vertical - type: string enum: - horizontal - type: string enum: - all description: 'Grid lines: ''none'', ''vertical'', ''horizontal'', or ''all''.' banding: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Row banding visibility: ''shown'' or ''hidden''.' bandingColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' autofitColumns: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Autofit column widths (level table only): ''shown'' or ''hidden''.' outerBorder: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Outer table border: ''shown'' or ''hidden''. Maps to inverted store `hideOuterBorder`.' headerDividerColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' heavyVerticalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier vertical group dividers (pivot only): ''shown'' or ''hidden''.' heavyHorizontalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier horizontal group dividers (pivot only): ''shown'' or ''hidden''.' textStyles: type: object properties: header: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' cell: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' columnHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' rowHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' titleFont: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Title font size in pixels (6–96). fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold - type: object properties: agents: type: array items: allOf: - type: object required: - id - instructions properties: id: type: string description: The identifier of the agent. instructions: type: string description: Instructions that guide the agent. Use {{formula}} for dynamic values, @dataSource("elementId") for configured data sources, and @tool("toolId") for configured tools. - type: object properties: name: type: string description: Display name for the agent. description: type: string description: Description of the agent. greeting: oneOf: - type: object required: - mode - message properties: mode: type: string enum: - static message: type: string description: The exact first message the assistant shows when the chat opens. Supports `{{formula}}` references. description: '' title: Fixed greeting - type: object required: - mode - prompt properties: mode: type: string enum: - generated prompt: type: string description: A prompt the agent runs to generate its first message when the chat opens. Supports `{{formula}}` references. description: '' title: Generated greeting description: The message a chat backed by this agent opens with. Omit for the default greeting. dataSources: type: array items: type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The ID of a workbook element (table or chart) the agent can read from. description: '' title: Workbook element description: Data sources that the agent can access, such as data model tables or workbook data elements. tools: type: array items: oneOf: - type: object required: - toolId - kind - connectorId - name properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - mcp-connector connectorId: type: string description: The UUID of the MCP connector. name: type: string description: The display name of the MCP connector. description: '' title: MCP connector - allOf: - type: object required: - toolId - kind properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - warehouse-agent - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object properties: description: type: string description: A description of when the agent should invoke this warehouse agent. description: '' title: Warehouse agent - allOf: - type: object required: - toolId - kind - description properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - search-service description: type: string description: A description of the content the search service can retrieve. - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. description: '' title: Search service - allOf: - type: object required: - toolId - kind - name - description - steps properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - action name: type: string description: The display name of the action tool. description: type: string description: What this tool does and when the agent should invoke it. steps: type: array items: oneOf: - allOf: - type: object required: - kind - sequenceId properties: kind: type: string enum: - sequence sequenceId: type: string description: Identifier for a workbook action sequence. - type: object properties: name: type: string description: Optional display name for this step. description: '' title: Sequence reference - allOf: - type: object required: - kind properties: kind: type: string enum: - effect - oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab - type: object properties: name: type: string description: Optional display name for this step. description: An action effect to run directly. Effects that depend on a user's element interaction, such as a selected row or column, are not supported. title: Inline effect description: Ordered steps the agent runs when it invokes this tool. - type: object properties: requiresApproval: type: boolean description: Whether the agent must get user approval before running this tool. description: '' title: Action description: Tools the agent can invoke. description: Workbook-level agents. Reference one from a chat element via `agentId`. - type: object properties: layout: oneOf: - type: string - type: 'null' description: Grid layout as XML. title: Layout XML - type: object properties: description: type: string description: The description of the workbook. responses: '200': description: The response body. content: application/json: schema: type: object required: - success - workbookId properties: success: type: boolean workbookId: type: string default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/spec/verify: post: summary: Verify a workbook code representation (Beta) description: 'This endpoint validates a workbook code representation without creating or modifying any workbook. It performs the same validation as the [/v2/workbooks/spec](https://help.sigmacomputing.com/reference/create-workbook-spec) endpoint but never persists the result, so you can confirm a representation is valid before creating a workbook from it. **Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### System and user requirements - To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish workbooks** permission. ### Usage notes - The response `valid` field indicates whether the representation passed validation. When `valid` is `false`, the `errors` array describes each validation failure. - The request body is identical to the [/v2/workbooks/spec](https://help.sigmacomputing.com/reference/create-workbook-spec) endpoint. - No workbook is created and no data is persisted by this endpoint. ### Usage scenarios - **Agentic workflows**: Agents can validate a generated representation before committing it to a create or update operation. - **Automation**: Validate representations in CI or migration tooling before applying them. ' parameters: [] operationId: verifyWorkbookSpec requestBody: description: The request body. content: application/json: schema: allOf: - type: object required: - name - folderId properties: name: type: string description: The name of the workbook. folderId: type: string description: The identifier of the folder in which the workbook is located. - allOf: - allOf: - type: object required: - schemaVersion properties: schemaVersion: type: number enum: - 1 description: The schema version used by this representation of the workbook. - type: object properties: kind: type: string enum: - workbook description: Document kind. Informational field, ignored when creating or updating a document. - type: object required: - pages properties: pages: type: array items: oneOf: - allOf: - type: object required: - id - type - name - elements properties: id: type: string description: The identifier of the modal page. type: type: string enum: - modal description: Marks this page as a modal. name: type: string description: The name of the modal. elements: type: array items: $ref: '#/components/schemas/WorkbookElement' description: The elements inside the modal. - type: object properties: modal: allOf: - type: object properties: width: oneOf: - type: string enum: - x-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large - type: string enum: - x-large description: 'Overlay width breakpoint: x-small, small, medium, large, or x-large.' header: type: object properties: title: type: string description: Header title. Supports dynamic-text {{formula}} references. showCloseIcon: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether the header shows the dismiss (X) icon: ''shown'' or ''hidden''.' description: 'Header configuration: title text and close-icon visibility.' - type: object properties: footer: type: object properties: primaryCta: type: object properties: visible: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether this CTA button is shown: ''shown'' or ''hidden''.' text: type: string description: CTA button label. Supports dynamic-text {{formula}} references. description: Primary footer CTA button. secondaryCta: type: object properties: visible: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether this CTA button is shown: ''shown'' or ''hidden''.' text: type: string description: CTA button label. Supports dynamic-text {{formula}} references. description: Secondary footer CTA button. description: Footer with primary/secondary CTA buttons. description: 'Modal presentation: width, header, and footer CTA buttons.' actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions fired by the modal (primary/secondary CTA click, or on close). backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional background image for the modal. Url supports dynamic-text {{formula}} references. title: Modal - allOf: - type: object required: - id - type - name - elements properties: id: type: string description: The identifier of the drawer page. type: type: string enum: - drawer description: Marks this page as a drawer. name: type: string description: The name of the drawer. elements: type: array items: $ref: '#/components/schemas/WorkbookElement' description: The elements inside the drawer. - type: object properties: drawer: allOf: - type: object properties: width: oneOf: - type: string enum: - x-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large - type: string enum: - x-large description: 'Overlay width breakpoint: x-small, small, medium, large, or x-large.' header: type: object properties: title: type: string description: Header title. Supports dynamic-text {{formula}} references. showCloseIcon: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether the header shows the dismiss (X) icon: ''shown'' or ''hidden''.' description: 'Header configuration: title text and close-icon visibility.' - type: object properties: position: oneOf: - type: string enum: - start - type: string enum: - end description: 'Which edge the drawer is anchored to: ''start'' (leading) or ''end'' (trailing).' showShadow: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether the dimming page overlay behind the drawer is shown: ''shown'' or ''hidden''.' description: 'Drawer presentation: width, header, anchor position, and page overlay.' actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions fired by the drawer (on close). backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional background image for the drawer. Url supports dynamic-text {{formula}} references. title: Drawer - allOf: - type: object required: - id - name - elements properties: id: type: string description: The identifier of the page in the data model. name: type: string description: The name of the page. elements: type: array items: $ref: '#/components/schemas/WorkbookElement' description: The elements on the page. - type: object properties: type: type: string enum: - page description: Marks this as a normal page. Defaults to 'page' when omitted. visibility: oneOf: - type: string enum: - hidden - type: object required: - kind - assignments properties: kind: type: string enum: - specific-users-and-teams assignments: type: object properties: users: type: array items: type: string description: The identifiers of the users allowed to view this page. teams: type: array items: type: string description: The identifiers of the teams allowed to view this page. description: The users and teams allowed to view this page, each by opaque id. An empty allowlist (both arrays omitted) is permitted. description: 'Page visibility. Set to `''hidden''` to hide the page from end users, or `{ kind: ''specific-users-and-teams'', assignments: { users: [...], teams: [...] } }` to restrict it to specific users/teams. Omit for a page visible to all users.' backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional page-level background image. Url supports dynamic-text {{formula}} references. title: Page description: The pages of the workbook spec and their contents. - type: object properties: themeName: oneOf: - oneOf: - type: string enum: - Light - type: string enum: - Dark - type: string enum: - Surface - type: string description: Built-in theme name (`Light`, `Dark`, `Surface`) or org theme UUID. themeOverrides: type: object properties: borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' categoricalScheme: oneOf: - type: string - type: array items: type: string description: Categorical color palette name or custom hex array. colorOverrides: type: object additionalProperties: type: string description: Per-token layout color overrides (hex). Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground). colors: type: object properties: text: type: string description: Primary text color (hex). highlight: type: string description: Highlight / accent color (hex). Maps to theme `$primary`. surface: type: string description: Surface color (hex). success: type: string description: Success color (hex). warning: type: string description: Warning color (hex). danger: type: string description: Danger color (hex). darkMode: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Dark color mode: ''shown'' or ''hidden''.' divergingScheme: type: string description: Named diverging color scheme. elementBorder: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' width: type: number description: Element border width in pixels (0–3). fonts: type: object properties: dataFont: type: string description: 'Data font family name (format panel: Data font).' textFont: type: string description: 'Text font family name (format panel: Text font).' hasCards: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Card-style element chrome: ''shown'' or ''hidden''.' invertTooltipColors: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Invert tooltip colors: ''shown'' or ''hidden''.' layoutColors: type: object properties: useElementForeground: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Render elements above the canvas: ''shown'' or ''hidden''.' maxPageWidth: type: number description: Max page width in pixels when pageWidth is custom (minimum 600). pageWidth: oneOf: - type: string enum: - full - type: string enum: - large - type: string enum: - medium - type: string enum: - custom description: 'Page content width: ''full'', ''large'', ''medium'', or ''custom''.' sequentialScheme: type: string description: Named sequential color scheme. space: type: object properties: showElementPadding: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Show padding around elements: ''shown'' or ''hidden''.' unit: oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Element spacing (format panel: Spacing): ''small'', ''medium'', or ''large''.' tableStyles: type: object properties: preset: oneOf: - type: string enum: - spreadsheet - type: string enum: - presentation description: 'Table preset: ''spreadsheet'' or ''presentation''. Omit when spreadsheet (default).' cellSpacing: oneOf: - type: string enum: - extra-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Cell spacing preset: ''extra-small'', ''small'', ''medium'', or ''large''.' gridLines: oneOf: - type: string enum: - none - type: string enum: - vertical - type: string enum: - horizontal - type: string enum: - all description: 'Grid lines: ''none'', ''vertical'', ''horizontal'', or ''all''.' banding: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Row banding visibility: ''shown'' or ''hidden''.' bandingColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' autofitColumns: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Autofit column widths (level table only): ''shown'' or ''hidden''.' outerBorder: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Outer table border: ''shown'' or ''hidden''. Maps to inverted store `hideOuterBorder`.' headerDividerColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' heavyVerticalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier vertical group dividers (pivot only): ''shown'' or ''hidden''.' heavyHorizontalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier horizontal group dividers (pivot only): ''shown'' or ''hidden''.' textStyles: type: object properties: header: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' cell: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' columnHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' rowHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' titleFont: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Title font size in pixels (6–96). fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold - type: object properties: agents: type: array items: allOf: - type: object required: - id - instructions properties: id: type: string description: The identifier of the agent. instructions: type: string description: Instructions that guide the agent. Use {{formula}} for dynamic values, @dataSource("elementId") for configured data sources, and @tool("toolId") for configured tools. - type: object properties: name: type: string description: Display name for the agent. description: type: string description: Description of the agent. greeting: oneOf: - type: object required: - mode - message properties: mode: type: string enum: - static message: type: string description: The exact first message the assistant shows when the chat opens. Supports `{{formula}}` references. description: '' title: Fixed greeting - type: object required: - mode - prompt properties: mode: type: string enum: - generated prompt: type: string description: A prompt the agent runs to generate its first message when the chat opens. Supports `{{formula}}` references. description: '' title: Generated greeting description: The message a chat backed by this agent opens with. Omit for the default greeting. dataSources: type: array items: type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The ID of a workbook element (table or chart) the agent can read from. description: '' title: Workbook element description: Data sources that the agent can access, such as data model tables or workbook data elements. tools: type: array items: oneOf: - type: object required: - toolId - kind - connectorId - name properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - mcp-connector connectorId: type: string description: The UUID of the MCP connector. name: type: string description: The display name of the MCP connector. description: '' title: MCP connector - allOf: - type: object required: - toolId - kind properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - warehouse-agent - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object properties: description: type: string description: A description of when the agent should invoke this warehouse agent. description: '' title: Warehouse agent - allOf: - type: object required: - toolId - kind - description properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - search-service description: type: string description: A description of the content the search service can retrieve. - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. description: '' title: Search service - allOf: - type: object required: - toolId - kind - name - description - steps properties: toolId: type: string description: The identifier of the tool within this agent. Use only letters, numbers, underscores, and hyphens. kind: type: string enum: - action name: type: string description: The display name of the action tool. description: type: string description: What this tool does and when the agent should invoke it. steps: type: array items: oneOf: - allOf: - type: object required: - kind - sequenceId properties: kind: type: string enum: - sequence sequenceId: type: string description: Identifier for a workbook action sequence. - type: object properties: name: type: string description: Optional display name for this step. description: '' title: Sequence reference - allOf: - type: object required: - kind properties: kind: type: string enum: - effect - oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab - type: object properties: name: type: string description: Optional display name for this step. description: An action effect to run directly. Effects that depend on a user's element interaction, such as a selected row or column, are not supported. title: Inline effect description: Ordered steps the agent runs when it invokes this tool. - type: object properties: requiresApproval: type: boolean description: Whether the agent must get user approval before running this tool. description: '' title: Action description: Tools the agent can invoke. description: Workbook-level agents. Reference one from a chat element via `agentId`. - type: object properties: layout: oneOf: - type: string - type: 'null' description: Grid layout as XML. title: Layout XML - type: object properties: description: type: string description: The description of the workbook. responses: '200': description: The response body. content: application/json: schema: oneOf: - type: object required: - valid properties: valid: type: boolean enum: - true description: The workbook code representation passed validation. description: A valid workbook code representation. - type: object required: - valid - errors properties: valid: type: boolean enum: - false description: The workbook code representation failed validation. errors: type: array items: type: object required: - summary properties: summary: type: string description: A human-readable description of a validation failure. description: The validation failures found in the code representation. description: An invalid workbook code representation, with the validation failures. default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2/workbooks/tag: post: summary: Tag a workbook description: "Add a version tag to a workbook and optionally set up a connection to swap to for a specific version of the workbook.\n\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - Retrieve the **tag** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `name` in the response.\n - Retrieve the **connectionId** to use as the **fromId** or **toId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.\n - If your workbook includes a source that is not mapped to a new source, that source is not swapped.\n - When swapping data models used as the source for the workbook:\n - You can only swap a data model source to another version of the same data model source. You cannot swap a data model source to a table in your data warehouse or a dataset.\n - When you swap sources from one data model version to a new one, specify the version tag of the data model that you swap to with `toVersionTagId`:\n - To swap to the latest published version of the data model, specify `toVersionTagId` as `null`.\n - To swap to a specific tagged version of the data model, specify the `toVersionTagId` of the data model.\n - If the workbook already uses a specific tagged version of a data model as a source, use `fromVersionTagId` to indicate which tagged version to swap from.\n - To swap from the latest published version of the data model, specify `fromVersionTagId` as `null`.\n - To swap from a specific tagged version of the data model, specify the `fromVersionTagId` of the data model.\n - To retrieve the `fromVersionTagId` for a data model used as the workbook source, call the [/v2/workbooks/{workbookId}/sources](https://help.sigmacomputing.com/reference/get-workbook-sources) endpoint and use the `versionTagId` in the response.\n - To retrieve the `versionTagId` for a data model, call the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint and use the `versionTagId` in the response.\n\n ### Usage scenarios\n - **Lifecycle management**: Identify production and development resources.\n " parameters: [] operationId: tagWorkbook requestBody: description: The request body. content: application/json: schema: allOf: - type: object required: - workbookId - tag properties: workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID tag: type: string description: Name of the version tag to apply. title: Version tag name - type: object properties: workbookVersion: type: number description: Specific version of the published workbook to tag. sourceMappingConfig: type: array items: type: object required: - fromConnectionId - toConnectionId - paths properties: fromConnectionId: type: string toConnectionId: type: string paths: type: array items: type: object required: - fromPath - toPath properties: fromPath: type: array items: type: string toPath: type: array items: type: string description: Swap sources for the workbook when you add a tag. dataModelSourceTaggedVersions: type: array items: type: object required: - dataModelId - fromVersionTagId - toVersionTagId properties: dataModelId: type: string fromVersionTagId: type: - string - 'null' toVersionTagId: type: - string - 'null' description: Which tagged version of the data model to use as the source. sourceVersions: type: object additionalProperties: type: number description: Which version of source datasets to use. grantSourceAccess: type: boolean description: Whether to grant users access to copied datasets if they create a copy via Save As. isDefault: type: boolean description: Whether to make this tag the default tagged version to load if the user doesn't have access to the published version. examples: Request Example: value: workbookId: '12345678910' workbookVersion: 4 tag: production sourceMappingConfig: - fromConnectionId: 00000000-0000-0000-0000-000000000000 toConnectionId: 00000000-0000-0000-0000-000000000001 paths: - fromPath: - SNOWFLAKE_DEVELOPMENT - WEATHER - DAILY_14_TOTAL toPath: - SNOWFLAKE_PRODUCTION - WEATHER - DAILY_16_TOTAL sourceVersions: : 2 isDefault: true responses: '200': description: The response body. content: application/json: schema: type: object required: - versionTagId - taggedWorkbookId - taggedWorkbookVersion properties: versionTagId: type: string taggedWorkbookId: type: string description: Unique identifier of the workbook. title: Workbook ID taggedWorkbookVersion: type: number default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2.1/workbooks/{workbookId}/materialization-schedules: get: summary: List materialization schedules for a workbook (Paginated) description: "\n **Attention:** This API endpoint uses pagination by default.\n\n This endpoint retrieves a list of all materialization schedules associated with a workbook. Each schedule details when and how often specific workbook elements are automatically materialized to optimize performance and data freshness.\n ### Usage notes\n - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - To retrieve additional pages of results, use the response of the `nextPage` parameter as the `page` query parameter in the following request.\n\n ### Usage scenarios\n - **Monitoring and management:** Administrators can monitor and manage the schedules for materialization to ensure optimal system performance.\n - **Audit and review:** Periodic reviews of materialization schedules can help in assessing the efficiency of data processes and making necessary adjustments.\n\n ### Best practices\n - Regularly review materialization schedules to align them with current data usage patterns and business needs.\n - Use pagination to manage large sets of data and improve response times of API calls." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: v2_1_listMaterializationSchedules responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: type: object required: - sheetId - elementId - elementName - schedule - configuredAt - paused properties: sheetId: type: string description: Identifier of the materialization schedule for the element title: Sheet ID elementId: type: string description: Identifier of the element being materialized title: Element ID elementName: type: string schedule: type: - object - 'null' properties: cronSpec: type: string description: Cron expression to use for the schedule timezone: type: string description: Timezone code, for example, PST configuredAt: type: string format: date-time paused: type: boolean description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. - type: object properties: total: type: number description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v2.1/workbooks/{workbookId}/schedules: get: summary: List scheduled workbook exports (Paginated) description: "\n **Attention:** This API endpoint uses pagination by default.\n\n This endpoint retrieves a list of all scheduled exports for a specified workbook. These schedules represent planned events that can trigger exports based on various conditions and timings.\n ### Usage Notes\n - The **workbookId** in the path parameter identifies the workbook whose scheduled exports are to be listed. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n - Use pagination query parameters to manage the volume of data returned by this endpoint.\n\n ### Usage Scenarios\n - **Schedule Overview:** Administrators or users with appropriate permissions can monitor and review all active scheduled exports associated with a workbook.\n - **Audit and Compliance:** This functionality is useful for auditing purposes to ensure that all scheduled operations are configured correctly and comply with organizational policies.\n\n ### Best Practices\n - Implement client-side handling to manage paginated data effectively, especially in cases where a workbook has a large number of scheduled exports.\n - Regularly audit schedules to keep them up-to-date and aligned with the current needs and workflows." parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true - name: page schema: type: string description: Use to specify further pages using the string returned in the nextPage portion of the response. title: Page in: query - name: limit schema: type: number description: Number of results to return per page, with a maximum of 1,000 per request. Use the `page` option in subsequent requests to retrieve the next set of results. title: Limit in: query operationId: v2_1_listWorkbookSchedules responses: '200': description: The response body. content: application/json: schema: allOf: - type: object required: - entries - nextPage properties: entries: type: array items: allOf: - type: object required: - scheduledNotificationId - workbookId - schedule - configV2 - isSuspended - ownerId - lastUpdatedByUser - disabledAt - disabledBy properties: scheduledNotificationId: type: string description: Unique identifier of the scheduled export. title: Schedule ID workbookId: type: string description: Unique identifier of the workbook. title: Workbook ID schedule: type: object required: - cronSpec - timezone properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. configV2: allOf: - type: object required: - title - messageBody - notificationAttachments properties: title: type: string messageBody: type: string notificationAttachments: type: array items: allOf: - type: object required: - formatOptions properties: formatOptions: oneOf: - type: object required: - type properties: type: type: string enum: - CSV - type: object required: - type properties: type: type: string enum: - JSON - type: object required: - type properties: type: type: string enum: - JSONL - type: object required: - type properties: type: type: string enum: - EXCEL - allOf: - type: object required: - type properties: type: type: string enum: - PDF - type: object properties: layout: type: string enum: - portrait - landscape scaleFactor: type: number - allOf: - type: object required: - type properties: type: type: string enum: - PNG - type: object properties: pixelWidth: type: - number - 'null' pixelHeight: type: - number - 'null' - type: object required: - type properties: type: type: string enum: - NONE - type: object properties: chartId: type: string workbookExportSource: oneOf: - type: object required: - type - elementId properties: type: type: string enum: - element elementId: type: string description: Export one element title: One element - type: object required: - type - pageId properties: type: type: string enum: - page pageId: type: string description: Export one page title: One page - type: object required: - type - nodeIds properties: type: type: string enum: - element nodeIds: type: array items: type: string description: Export multiple elements title: Multiple elements - type: object required: - type - nodeIds properties: type: type: string enum: - page nodeIds: type: array items: type: string description: Export multiple pages title: Multiple pages - type: object required: - type properties: type: type: string enum: - all description: Export all pages and elements in a workbook title: Entire workbook - type: object properties: includeLink: type: boolean runAsRecipient: type: boolean attachmentSettings: type: object properties: mergePdfAttachments: type: boolean zipAttachments: type: boolean conditionOptions: oneOf: - type: object required: - type properties: type: type: string enum: - always - type: object required: - type - conditions properties: type: type: string enum: - workbook conditions: type: array items: oneOf: - type: object required: - type - sheetId properties: type: type: string enum: - isEmpty sheetId: type: string - type: object required: - type - sheetId properties: type: type: string enum: - isNotEmpty sheetId: type: string - allOf: - type: object required: - type - sheetId - mode - columnId - op properties: type: type: string enum: - sheetColumn sheetId: type: string mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' - type: object required: - type - conditions properties: type: type: string enum: - worksheet conditions: type: array items: oneOf: - type: object required: - type properties: type: type: string enum: - isEmpty - type: object required: - type properties: type: type: string enum: - isNotEmpty - allOf: - type: object required: - type - mode - columnId - op properties: type: type: string enum: - queryColumn mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' - type: object required: - type - conditions properties: type: type: string enum: - dashboard conditions: type: array items: oneOf: - type: object required: - type - tileId properties: type: type: string enum: - isEmpty tileId: type: string - type: object required: - type - tileId properties: type: type: string enum: - isNotEmpty tileId: type: string - allOf: - type: object required: - type - tileId - mode - columnId - op properties: type: type: string enum: - chartColumn tileId: type: string mode: oneOf: - type: string enum: - any - type: string enum: - all columnId: type: string op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith - type: object properties: value: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number - type: object required: - type - val properties: type: type: string enum: - integer val: type: string - type: object required: - type - val properties: type: type: string enum: - string val: type: string - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string - type: object required: - type - val properties: type: type: string enum: - error val: type: string - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: {} - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' - type: object required: - type - val properties: type: type: string enum: - variant val: type: string type: 'null' alertConfig: allOf: - type: object required: - window properties: window: type: string enum: - alltime - daily - weekly - always - type: object properties: volume: oneOf: - type: number - type: 'null' notificationName: type: string dashboardSettings: type: object properties: filters: type: array items: type: object required: - id - filterStr properties: id: type: string filterStr: type: string variableValues: $ref: '#/components/schemas/DashVariables' dynamicExportSettings: type: object properties: variables: type: object additionalProperties: oneOf: - type: object required: - type properties: type: type: string enum: - boolean - type: object required: - type properties: type: type: string enum: - number - type: object required: - type properties: type: type: string enum: - text - type: object required: - type properties: type: type: string enum: - date - type: object required: - type properties: type: type: string enum: - number-list - type: object required: - type properties: type: type: string enum: - text-list - type: object required: - type properties: type: type: string enum: - date-list - type: object required: - type properties: type: type: string enum: - boolean-list - type: object required: - type properties: type: type: string enum: - date-range - type: object required: - type properties: type: type: string enum: - number-range - type: object required: - type properties: type: type: string enum: - date-null - type: object required: - type properties: type: type: string enum: - number-null - type: object required: - type properties: type: type: string enum: - text-null - type: object required: - type properties: type: type: string enum: - boolean-null type: object dynamicRecipientSettings: type: object required: - sourceNodeId - recipientColumnId properties: sourceNodeId: type: string recipientColumnId: type: string rowLimit: type: number workbookVariant: type: object properties: tagId: type: string exploreKey: type: string bookmarkId: type: string embedOpts: type: object properties: embedId: type: string evalConnectionId: type: string formatting: type: - object - 'null' properties: pivotHeaderStyle: type: - string - 'null' enum: - merged - repeated isSuspended: type: boolean description: Whether the schedule is currently suspended. ownerId: type: string description: Unique identifier of the user who owns the schedule. title: Owner ID lastUpdatedByUser: type: string description: Unique identifier of the user who last updated the schedule. title: Last Updated By disabledAt: type: - string - 'null' format: date-time description: Timestamp when the schedule was disabled, or null if the schedule is active. title: Disabled At disabledBy: type: - string - 'null' description: Unique identifier of the member who disabled the schedule, or null if the schedule is active. title: Disabled By - type: object required: - createdBy - updatedBy - createdAt - updatedAt properties: createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. - type: object properties: total: type: number description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations /v3alpha/workbooks/{workbookId}:swapSources: post: summary: Swap workbook sources (Beta) description: 'Swap each data source used by a workbook. You can swap from one table, dataset, data model element, or custom SQL element to another for each data source. **Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint. - Retrieve workbook sources by calling the [/v2/workbooks/{workbookId}/sources](https://help.sigmacomputing.com/reference/get-workbook-sources) endpoint. - Retrieve the **dataModelId** by calling the [/v2/dataModels](https://help.sigmacomputing.com/reference/list-data-models) endpoint. - Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint. - Retrieve the **tableId** by calling the [/v2/connection](https://help.sigmacomputing.com/reference/lookup-connection) endpoint. - Retrieve the **connectionId** for a new custom SQL element by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint. - Use the `sourceMapping` options in the request body to swap specific sources. For each source in the source mapping, provide the current source in use in the **from** object, and provide the source that you want to use instead in the **to** object. - If your source is a data model with one or more tagged versions, you can also provide a `versionTagId` to swap to or from a tagged version of the data model. The data model version must already be tagged. - When swapping **from** a custom SQL element, identify it by its element ID using the `customSqlId` field. When swapping **to** a custom SQL element, supply the `connectionId` of the connection to run against and the SQL query in the `definition` field. - If your source is a data model or a dataset, you can use the `metricMapping` option to map metrics that rely on column names from the old source to the new one so that they continue to work. - If the source that you swap from uses column names, links, or relationships different from the source that you are swapping to, use the `columnMapping` option to map each column in the original source to a corresponding column in the new source. - When `columnMapping` is omitted, columns are automatically matched by display name, ignoring differences in case and punctuation. For example, a custom SQL output column named `DOCK_COUNT` automatically maps to a data model column with display name `Dock Count`. Provide `columnMapping` explicitly to override the automatic match for a column. ### Usage scenarios - **Workbook development**: Use a test data source during development, then swap to a production source when ready to share the workbook. - **Dataset migration**: Update references to deprecated dataset sources with data model sources by mapping dataset IDs to their new data model equivalents. ' parameters: - name: workbookId schema: type: string description: Unique identifier of the workbook. title: Workbook ID in: path required: true operationId: v3alpha_sourceSwapWorkbook requestBody: description: The request body. content: application/json: schema: type: object required: - sourceMapping properties: sourceMapping: type: array items: allOf: - type: object required: - from - to properties: from: oneOf: - type: object required: - type - tableId properties: type: type: string enum: - table tableId: type: string description: '' title: Table source - type: object required: - type - datasetId properties: type: type: string enum: - dataset datasetId: type: string description: '' title: Dataset source (deprecated) - allOf: - type: object required: - type - dataModelId - elementId properties: type: type: string enum: - data-model dataModelId: type: string elementId: type: string description: ID of the element in the data model title: Data model element ID - type: object properties: versionTagId: type: string description: '' title: Data model source - type: object required: - type - customSqlId properties: type: type: string enum: - custom-sql customSqlId: type: string description: ID of the element associated with the custom SQL element. title: Custom SQL element ID description: '' title: Custom SQL element description: Source to swap from. title: From data source to: oneOf: - type: object required: - type - tableId properties: type: type: string enum: - table tableId: type: string description: '' title: Table source - type: object required: - type - datasetId properties: type: type: string enum: - dataset datasetId: type: string description: '' title: Dataset source (deprecated) - allOf: - type: object required: - type - dataModelId - elementId properties: type: type: string enum: - data-model dataModelId: type: string elementId: type: string description: ID of the element in the data model title: Data model element ID - type: object properties: versionTagId: type: string description: '' title: Data model source - type: object required: - type - connectionId - definition properties: type: type: string enum: - custom-sql connectionId: type: string description: ID of the connection that the new custom SQL element will run against. title: Connection ID definition: type: string description: SQL query that defines the new custom SQL element. title: SQL definition description: '' title: Custom SQL element description: Source to swap to. title: To data source - type: object properties: metricMapping: type: array items: type: object required: - fromMetricId - toMetricId properties: fromMetricId: type: string description: Identifier of the metric in the data source title: Metric ID toMetricId: type: string description: Identifier of the metric in the data source title: Metric ID columnMapping: type: array items: type: object required: - fromColumn - toColumn properties: fromColumn: oneOf: - type: array items: type: string description: Column ID in the form ["column_id"] title: Column ID - type: array items: type: string description: Dataset or table link in the form ["link_name", "column_name"] title: Link - type: array items: type: string description: Relationship in the form ["relationship_id", "column_name"] title: Relationship toColumn: oneOf: - type: array items: type: string description: Column ID in the form ["column_id"] title: Column ID - type: array items: type: string description: Dataset or table link in the form ["link_name", "column_name"] title: Link - type: array items: type: string description: Relationship in the form ["relationship_id", "column_name"] title: Relationship responses: '200': description: The response body. content: application/json: schema: type: object properties: {} default: $ref: '#/components/responses/ApiError' externalDocs: url: '' description: 'Sigma API documentation:' tags: - workbooks security: - oauth2: [] servers: - url: https://api.sigmacomputing.com description: Server for GCP (US) hosted organizations - url: https://api.sa.gcp.sigmacomputing.com description: Server for GCP (KSA) hosted organizations - url: https://aws-api.sigmacomputing.com description: Server for AWS US (West) hosted organizations - url: https://api.us-a.aws.sigmacomputing.com description: Server for AWS US (East) hosted organizations - url: https://api.ca.aws.sigmacomputing.com description: Server for AWS Canada hosted organizations - url: https://api.eu.aws.sigmacomputing.com description: Server for AWS Europe hosted organizations - url: https://api.au.aws.sigmacomputing.com description: Server for AWS Australia and APAC hosted organizations - url: https://api.uk.aws.sigmacomputing.com description: Server for AWS UK hosted organizations - url: https://api.us.azure.sigmacomputing.com description: Server for Azure US hosted organizations - url: https://api.eu.azure.sigmacomputing.com description: Server for Azure Europe hosted organizations - url: https://api.ca.azure.sigmacomputing.com description: Server for Azure Canada hosted organizations - url: https://api.uk.azure.sigmacomputing.com description: Server for Azure United Kingdom hosted organizations - url: https://api.au.azure.sigmacomputing.com description: Server for Azure Australia hosted organizations components: schemas: WorkbookElement: oneOf: - allOf: - $ref: '#/components/schemas/CommonElement' title: Common elements - allOf: - type: object required: - id - kind properties: id: type: string description: The identifier of the chat element. kind: type: string enum: - chat - type: object properties: agentId: type: string description: ID of a workbook agent (see `agents`) connected to this chat element. description: '' title: Chat - allOf: - type: object required: - id - kind properties: id: type: string description: The identifier of the container. kind: type: string enum: - container - type: object properties: style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' backgroundImage: allOf: - type: object required: - source properties: source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: style: type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' description: 'Visual customization: fit, alignment, and tiling.' description: Optional background image for the container. Url supports dynamic-text {{formula}} references. description: '' title: Container - allOf: - type: object required: - id - kind - fields properties: id: type: string description: The identifier of the form. kind: type: string enum: - form fields: type: array items: allOf: - type: object required: - type properties: type: oneOf: - type: string enum: - text - type: string enum: - text-area - type: string enum: - number - type: string enum: - date - type: string enum: - checkbox description: The input type of the field. - type: object properties: label: type: string description: The label shown for the field. placeholder: type: string description: Placeholder text shown while the field is empty. required: oneOf: - type: string enum: - required - type: string enum: - optional description: Whether the field must be filled before the form submits (default `optional`). readOnly: oneOf: - type: string enum: - readonly - type: string enum: - editable description: Whether the field is editable or displayed read-only (default `editable`). description: The form fields, in display order. - type: object properties: style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' description: '' title: Form - allOf: - type: object required: - id - kind - tabs properties: id: type: string description: The identifier of the tabbed container. kind: type: string enum: - tabbed-container tabs: type: array items: type: object required: - name properties: name: type: string description: The label shown on the tab. description: Ordered list of tabs (at least one). The first tab is the default. - type: object properties: style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' spacing: oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Element spacing (format panel: Spacing): ''small'', ''medium'', or ''large''.' elementGap: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Gap between child elements: ''shown'' (default) or ''hidden''.' tabBar: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Tab bar visibility: ''shown'' (default) or ''hidden''.' style: oneOf: - type: string enum: - open - type: string enum: - box - type: string enum: - button description: 'Tab style: ''open'' (default), ''box'', or ''button''.' alignment: oneOf: - type: string enum: - start - type: string enum: - center - type: string enum: - end - type: string enum: - justify description: 'Tab bar alignment: ''start'' (default), ''center'', ''end'', or ''justify''.' size: oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Tab bar size: ''small'', ''medium'' (default), or ''large''.' description: 'Tab bar appearance: visibility, style, alignment, and size.' description: '' title: Tabbed container - oneOf: - allOf: - allOf: - type: object required: - id - kind properties: id: type: string description: The identifier of the navigation element. kind: type: string enum: - navigation - type: object properties: style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' optionStyle: type: object properties: style: oneOf: - type: string enum: - line - type: string enum: - pill description: 'Option style: ''line'' (default) or ''pill''.' orientation: oneOf: - type: string enum: - horizontal - type: string enum: - vertical description: 'Layout direction: ''horizontal'' (default) or ''vertical''.' alignment: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right - type: string enum: - justify description: 'Alignment: ''left'' (default), ''center'', ''right'', or ''justify''. ''justify'' only applies to horizontal orientation.' size: oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Size: ''small'', ''medium'' (default), or ''large''.' textColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Label color for unselected options. selectedColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Label + indicator color for the selected option. description: 'Appearance of the option buttons: style, orientation, alignment, size, and colors.' - type: object required: - mode - options properties: mode: type: string enum: - manual options: type: array items: oneOf: - allOf: - type: object required: - submenu properties: submenu: type: array items: type: object properties: label: type: string description: The option label. Falls back to the destination's own label when omitted. icon: oneOf: - type: object required: - type - emoji properties: type: type: string enum: - emoji emoji: type: string description: An emoji character. title: Emoji - type: object required: - type - name - variant properties: type: type: string enum: - icon name: type: string enum: - Accessibility - Action - Ai - AlignBottom - AlignCenterHorizontal - AlignCenterVertical - AlignLeft - AlignRight - AlignStretch - AlignTop - AlloyDb - Anchor - Api - ArrowDown - ArrowDownCircle - ArrowDownShort - ArrowLeft - ArrowLeftCircle - ArrowLeftShort - ArrowRight - ArrowRightCircle - ArrowRightShort - ArrowUp - ArrowUpCircle - ArrowUpDown - ArrowUpShort - At - Auto - Aws - AxisXBottom - AxisXTop - AxisYLeft - AxisYRight - Azure - Ban - BanCircle - Bars - Bell - BigQuery - Blank - Bold - Book - Bookmark - BordersAll - BordersDivider - BordersHorizontal - BordersNone - BordersVertical - Brand1 - Brand2 - Brand3 - Brand4 - Brand5 - Brand6 - BreakLink - Bricks - Bucket - BucketArrow - Button - Calendar - CaretDown - CaretUp - Check - CheckCircle - CheckDouble - CheckSquare - ChevronLargeDoubleDown - ChevronLargeDoubleLeft - ChevronLargeDoubleRight - ChevronLargeDoubleUp - ChevronLargeDown - ChevronLargeLeft - ChevronLargeRight - ChevronLargeUp - ChevronSmallDoubleDown - ChevronSmallDoubleLeft - ChevronSmallDoubleRight - ChevronSmallDoubleUp - ChevronSmallDown - ChevronSmallLeft - ChevronSmallRight - ChevronSmallUp - Circle - CircleSmall - Clickhouse - Clock - Cloud - CloudDownload - CloudUpload - Cold - ColumnMove - Compass - Confluence - Container - Controls - Copy - CornerPill - CornerRounded - CornerSquare - CrossOrg - Crosshairs - Dashboard - DataModel - Database - DatabaseMove - DatabaseSimple - Databricks - Dataset - Dbt - Desktop - Document - DocumentCsv - DocumentPdf - DocumentSql - Dollar - Download - DragHandle - DragShift - Dropdown - DropdownTrigger - Duplicate - EditorPython - EditorSql - EllipsisHorizontal - EllipsisVertical - EmailBurst - Embed - Envelope - EnvelopeBurst - EnvelopeOpen - Epsilon - EpsilonSquare - Eraser - Exclamation - ExclamationCircle - ExclamationOctagon - ExclamationSquare - ExclamationTriangle - ExpandPreview - Explore - Eye - EyeDropper - EyeSlash - Family - Flag - Folder - Form - FormatDecrease - FormatIncrease - FormatSeparateColumns - FormatSingleColumn - Funnel - Fx - Gear - Globe - GoogleAds - GoogleCloud - GoogleDrive - GoogleSheets - GridBlocks - GridDots - Header - Hierarchy - Highlight - Hightouch - Home - HorizonElementBlocks - HorizonElementCharts - HorizonElementControls - HorizonElementData - HorizonElementInput - HorizonElementLayout - HorizonElementUi - Hot - Image - InfoCircle - Italic - Join - Key - LayoutColumn - LayoutGroup - LayoutRow - LayoutStackHorizontal - LayoutStackVertical - Letter - Lightning - Limit - Line - Lineage - Link - List - ListBullets - ListCheck - ListNumbers - ListOverview - ListRadioButton - ListShapes - ListValue - ListYesNo - Lock - Logical - Lookup - MagnifyingGlass - MapExplore - MapPin - Mariadb - MarkSize - Materialization - Maximize - Mcp - Microphone - Microsoft - Minimize - Minus - MinusAlt - MinusCircle - MinusSquare - Mobile - Modal - ModalClose - ModalOpen - Moon - MsTeams - MySql - Number - NumberHierarchy - Octagon - Office - Offline - OpenNew - PageBreak - Pages - PaintBrush - PaintBucket - PaintRoller - PasswordReset - Pause - PauseCircle - Pencil - PeppermintAi - PeppermintBell - PeppermintChat - PeppermintDatabase - PeppermintFolder - PeppermintGear - PeppermintMagnifyingGlass - PeppermintPalette - PeppermintPencilBox - PeppermintPlus - PeppermintSidebar - PeppermintTemplate - Percent - Phi - Play - PlayCircle - PlayDesktop - PlugsElectronics - Plus - PlusCircle - PlusCircleSubtle - PlusSquare - PostgreSql - ProgressBar - ProgressRing - Puzzle - Python - QuestionCircle - RangeSlider - ReLink - Record - Rectangle - Redo - Redshift - Refresh - RefreshCircle - Reload - Replay - Report - Robot - RowPlus - RowX - Scissors - Section - SegmentedControl - Share - Sharepoint - Shortcut - Sidebar - SidebarHidden - SidebarVisible - Sigma - Slack - Slider - Snapshot - Snowflake - SortAscending - SortDescending - Spacer - SpeechBubble - Spin - SqlServer - Square - SquareSmall - Star - Starburst - Store - Strikethrough - Subscript - Sun - Superscript - Switch - Table - Tabs - Tags - Team - Text - TextAlignCenter - TextAlignLeft - TextAlignRight - TextArea - TextClip - TextColor - TextWrap - Textbox - TextboxNumber - ThumbsUp - TileClone - Tooltip - Transparent - Transpose - Trash - Trellis - Triangle - Trino - UnNest - Underline - Undo - Union - Unlock - Upload - Usage - User - UserCard - UserCircle - UserSwap - Variant - Vault - ViewExtend - VizArea - VizAreaStacked - VizAreaStackedPercent - VizAreaUnstacked - VizBarHorizontal - VizBarStacked - VizBarStackedPercent - VizBarUnstacked - VizBarVertical - VizBox - VizCombo - VizDonut - VizFunnel - VizGauge - VizHighlight - VizInputTable - VizInputTableLinked - VizKpi - VizLine - VizMap - VizPie - VizPivotTable - VizPlaceholder - VizSankey - VizScatter - VizSingleValue - VizTable - VizTreemap - VizWaterfall - Wand - Webhooks - Workbook - WorkbookForModifiers - WorkbookTemplate - Worksheet - Workspace - X - XCircle - XSquare description: A supported Sigma icon name, e.g. `Document`. title: Icon name variant: oneOf: - type: string enum: - filled - type: string enum: - outlined - type: string enum: - toned description: 'Icon style variant: ''filled'', ''outlined'' (default), or ''toned''.' description: A named icon (by name and style variant). title: Icon description: An emoji or icon. destination: oneOf: - type: object required: - type - pageId properties: type: type: string enum: - page pageId: type: string description: Navigates to the top of a workbook page. title: Page destination - type: object required: - type - elementId properties: type: type: string enum: - element elementId: type: string description: Navigates (anchors) to an element on a page. title: Element destination - allOf: - type: object required: - type - url properties: type: type: string enum: - link url: type: string - type: object properties: openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the link opens: _self (same tab), _blank (new tab, default), or _parent (parent frame).' description: Opens an external URL. title: External link - type: object required: - type properties: type: type: string enum: - none description: The option has no destination. title: No destination description: 'The option''s destination: a workbook ''page'', an ''element'' anchor, an external ''link'', or ''none''.' description: Child options shown under this submenu (one level). - type: object properties: label: type: string icon: oneOf: - type: object required: - type - emoji properties: type: type: string enum: - emoji emoji: type: string description: An emoji character. title: Emoji - type: object required: - type - name - variant properties: type: type: string enum: - icon name: type: string enum: - Accessibility - Action - Ai - AlignBottom - AlignCenterHorizontal - AlignCenterVertical - AlignLeft - AlignRight - AlignStretch - AlignTop - AlloyDb - Anchor - Api - ArrowDown - ArrowDownCircle - ArrowDownShort - ArrowLeft - ArrowLeftCircle - ArrowLeftShort - ArrowRight - ArrowRightCircle - ArrowRightShort - ArrowUp - ArrowUpCircle - ArrowUpDown - ArrowUpShort - At - Auto - Aws - AxisXBottom - AxisXTop - AxisYLeft - AxisYRight - Azure - Ban - BanCircle - Bars - Bell - BigQuery - Blank - Bold - Book - Bookmark - BordersAll - BordersDivider - BordersHorizontal - BordersNone - BordersVertical - Brand1 - Brand2 - Brand3 - Brand4 - Brand5 - Brand6 - BreakLink - Bricks - Bucket - BucketArrow - Button - Calendar - CaretDown - CaretUp - Check - CheckCircle - CheckDouble - CheckSquare - ChevronLargeDoubleDown - ChevronLargeDoubleLeft - ChevronLargeDoubleRight - ChevronLargeDoubleUp - ChevronLargeDown - ChevronLargeLeft - ChevronLargeRight - ChevronLargeUp - ChevronSmallDoubleDown - ChevronSmallDoubleLeft - ChevronSmallDoubleRight - ChevronSmallDoubleUp - ChevronSmallDown - ChevronSmallLeft - ChevronSmallRight - ChevronSmallUp - Circle - CircleSmall - Clickhouse - Clock - Cloud - CloudDownload - CloudUpload - Cold - ColumnMove - Compass - Confluence - Container - Controls - Copy - CornerPill - CornerRounded - CornerSquare - CrossOrg - Crosshairs - Dashboard - DataModel - Database - DatabaseMove - DatabaseSimple - Databricks - Dataset - Dbt - Desktop - Document - DocumentCsv - DocumentPdf - DocumentSql - Dollar - Download - DragHandle - DragShift - Dropdown - DropdownTrigger - Duplicate - EditorPython - EditorSql - EllipsisHorizontal - EllipsisVertical - EmailBurst - Embed - Envelope - EnvelopeBurst - EnvelopeOpen - Epsilon - EpsilonSquare - Eraser - Exclamation - ExclamationCircle - ExclamationOctagon - ExclamationSquare - ExclamationTriangle - ExpandPreview - Explore - Eye - EyeDropper - EyeSlash - Family - Flag - Folder - Form - FormatDecrease - FormatIncrease - FormatSeparateColumns - FormatSingleColumn - Funnel - Fx - Gear - Globe - GoogleAds - GoogleCloud - GoogleDrive - GoogleSheets - GridBlocks - GridDots - Header - Hierarchy - Highlight - Hightouch - Home - HorizonElementBlocks - HorizonElementCharts - HorizonElementControls - HorizonElementData - HorizonElementInput - HorizonElementLayout - HorizonElementUi - Hot - Image - InfoCircle - Italic - Join - Key - LayoutColumn - LayoutGroup - LayoutRow - LayoutStackHorizontal - LayoutStackVertical - Letter - Lightning - Limit - Line - Lineage - Link - List - ListBullets - ListCheck - ListNumbers - ListOverview - ListRadioButton - ListShapes - ListValue - ListYesNo - Lock - Logical - Lookup - MagnifyingGlass - MapExplore - MapPin - Mariadb - MarkSize - Materialization - Maximize - Mcp - Microphone - Microsoft - Minimize - Minus - MinusAlt - MinusCircle - MinusSquare - Mobile - Modal - ModalClose - ModalOpen - Moon - MsTeams - MySql - Number - NumberHierarchy - Octagon - Office - Offline - OpenNew - PageBreak - Pages - PaintBrush - PaintBucket - PaintRoller - PasswordReset - Pause - PauseCircle - Pencil - PeppermintAi - PeppermintBell - PeppermintChat - PeppermintDatabase - PeppermintFolder - PeppermintGear - PeppermintMagnifyingGlass - PeppermintPalette - PeppermintPencilBox - PeppermintPlus - PeppermintSidebar - PeppermintTemplate - Percent - Phi - Play - PlayCircle - PlayDesktop - PlugsElectronics - Plus - PlusCircle - PlusCircleSubtle - PlusSquare - PostgreSql - ProgressBar - ProgressRing - Puzzle - Python - QuestionCircle - RangeSlider - ReLink - Record - Rectangle - Redo - Redshift - Refresh - RefreshCircle - Reload - Replay - Report - Robot - RowPlus - RowX - Scissors - Section - SegmentedControl - Share - Sharepoint - Shortcut - Sidebar - SidebarHidden - SidebarVisible - Sigma - Slack - Slider - Snapshot - Snowflake - SortAscending - SortDescending - Spacer - SpeechBubble - Spin - SqlServer - Square - SquareSmall - Star - Starburst - Store - Strikethrough - Subscript - Sun - Superscript - Switch - Table - Tabs - Tags - Team - Text - TextAlignCenter - TextAlignLeft - TextAlignRight - TextArea - TextClip - TextColor - TextWrap - Textbox - TextboxNumber - ThumbsUp - TileClone - Tooltip - Transparent - Transpose - Trash - Trellis - Triangle - Trino - UnNest - Underline - Undo - Union - Unlock - Upload - Usage - User - UserCard - UserCircle - UserSwap - Variant - Vault - ViewExtend - VizArea - VizAreaStacked - VizAreaStackedPercent - VizAreaUnstacked - VizBarHorizontal - VizBarStacked - VizBarStackedPercent - VizBarUnstacked - VizBarVertical - VizBox - VizCombo - VizDonut - VizFunnel - VizGauge - VizHighlight - VizInputTable - VizInputTableLinked - VizKpi - VizLine - VizMap - VizPie - VizPivotTable - VizPlaceholder - VizSankey - VizScatter - VizSingleValue - VizTable - VizTreemap - VizWaterfall - Wand - Webhooks - Workbook - WorkbookForModifiers - WorkbookTemplate - Worksheet - Workspace - X - XCircle - XSquare description: A supported Sigma icon name, e.g. `Document`. title: Icon name variant: oneOf: - type: string enum: - filled - type: string enum: - outlined - type: string enum: - toned description: 'Icon style variant: ''filled'', ''outlined'' (default), or ''toned''.' description: A named icon (by name and style variant). title: Icon description: An emoji or icon. description: A submenu of menu items (one level). title: Submenu - type: object properties: label: type: string description: The option label. Falls back to the destination's own label when omitted. icon: oneOf: - type: object required: - type - emoji properties: type: type: string enum: - emoji emoji: type: string description: An emoji character. title: Emoji - type: object required: - type - name - variant properties: type: type: string enum: - icon name: type: string enum: - Accessibility - Action - Ai - AlignBottom - AlignCenterHorizontal - AlignCenterVertical - AlignLeft - AlignRight - AlignStretch - AlignTop - AlloyDb - Anchor - Api - ArrowDown - ArrowDownCircle - ArrowDownShort - ArrowLeft - ArrowLeftCircle - ArrowLeftShort - ArrowRight - ArrowRightCircle - ArrowRightShort - ArrowUp - ArrowUpCircle - ArrowUpDown - ArrowUpShort - At - Auto - Aws - AxisXBottom - AxisXTop - AxisYLeft - AxisYRight - Azure - Ban - BanCircle - Bars - Bell - BigQuery - Blank - Bold - Book - Bookmark - BordersAll - BordersDivider - BordersHorizontal - BordersNone - BordersVertical - Brand1 - Brand2 - Brand3 - Brand4 - Brand5 - Brand6 - BreakLink - Bricks - Bucket - BucketArrow - Button - Calendar - CaretDown - CaretUp - Check - CheckCircle - CheckDouble - CheckSquare - ChevronLargeDoubleDown - ChevronLargeDoubleLeft - ChevronLargeDoubleRight - ChevronLargeDoubleUp - ChevronLargeDown - ChevronLargeLeft - ChevronLargeRight - ChevronLargeUp - ChevronSmallDoubleDown - ChevronSmallDoubleLeft - ChevronSmallDoubleRight - ChevronSmallDoubleUp - ChevronSmallDown - ChevronSmallLeft - ChevronSmallRight - ChevronSmallUp - Circle - CircleSmall - Clickhouse - Clock - Cloud - CloudDownload - CloudUpload - Cold - ColumnMove - Compass - Confluence - Container - Controls - Copy - CornerPill - CornerRounded - CornerSquare - CrossOrg - Crosshairs - Dashboard - DataModel - Database - DatabaseMove - DatabaseSimple - Databricks - Dataset - Dbt - Desktop - Document - DocumentCsv - DocumentPdf - DocumentSql - Dollar - Download - DragHandle - DragShift - Dropdown - DropdownTrigger - Duplicate - EditorPython - EditorSql - EllipsisHorizontal - EllipsisVertical - EmailBurst - Embed - Envelope - EnvelopeBurst - EnvelopeOpen - Epsilon - EpsilonSquare - Eraser - Exclamation - ExclamationCircle - ExclamationOctagon - ExclamationSquare - ExclamationTriangle - ExpandPreview - Explore - Eye - EyeDropper - EyeSlash - Family - Flag - Folder - Form - FormatDecrease - FormatIncrease - FormatSeparateColumns - FormatSingleColumn - Funnel - Fx - Gear - Globe - GoogleAds - GoogleCloud - GoogleDrive - GoogleSheets - GridBlocks - GridDots - Header - Hierarchy - Highlight - Hightouch - Home - HorizonElementBlocks - HorizonElementCharts - HorizonElementControls - HorizonElementData - HorizonElementInput - HorizonElementLayout - HorizonElementUi - Hot - Image - InfoCircle - Italic - Join - Key - LayoutColumn - LayoutGroup - LayoutRow - LayoutStackHorizontal - LayoutStackVertical - Letter - Lightning - Limit - Line - Lineage - Link - List - ListBullets - ListCheck - ListNumbers - ListOverview - ListRadioButton - ListShapes - ListValue - ListYesNo - Lock - Logical - Lookup - MagnifyingGlass - MapExplore - MapPin - Mariadb - MarkSize - Materialization - Maximize - Mcp - Microphone - Microsoft - Minimize - Minus - MinusAlt - MinusCircle - MinusSquare - Mobile - Modal - ModalClose - ModalOpen - Moon - MsTeams - MySql - Number - NumberHierarchy - Octagon - Office - Offline - OpenNew - PageBreak - Pages - PaintBrush - PaintBucket - PaintRoller - PasswordReset - Pause - PauseCircle - Pencil - PeppermintAi - PeppermintBell - PeppermintChat - PeppermintDatabase - PeppermintFolder - PeppermintGear - PeppermintMagnifyingGlass - PeppermintPalette - PeppermintPencilBox - PeppermintPlus - PeppermintSidebar - PeppermintTemplate - Percent - Phi - Play - PlayCircle - PlayDesktop - PlugsElectronics - Plus - PlusCircle - PlusCircleSubtle - PlusSquare - PostgreSql - ProgressBar - ProgressRing - Puzzle - Python - QuestionCircle - RangeSlider - ReLink - Record - Rectangle - Redo - Redshift - Refresh - RefreshCircle - Reload - Replay - Report - Robot - RowPlus - RowX - Scissors - Section - SegmentedControl - Share - Sharepoint - Shortcut - Sidebar - SidebarHidden - SidebarVisible - Sigma - Slack - Slider - Snapshot - Snowflake - SortAscending - SortDescending - Spacer - SpeechBubble - Spin - SqlServer - Square - SquareSmall - Star - Starburst - Store - Strikethrough - Subscript - Sun - Superscript - Switch - Table - Tabs - Tags - Team - Text - TextAlignCenter - TextAlignLeft - TextAlignRight - TextArea - TextClip - TextColor - TextWrap - Textbox - TextboxNumber - ThumbsUp - TileClone - Tooltip - Transparent - Transpose - Trash - Trellis - Triangle - Trino - UnNest - Underline - Undo - Union - Unlock - Upload - Usage - User - UserCard - UserCircle - UserSwap - Variant - Vault - ViewExtend - VizArea - VizAreaStacked - VizAreaStackedPercent - VizAreaUnstacked - VizBarHorizontal - VizBarStacked - VizBarStackedPercent - VizBarUnstacked - VizBarVertical - VizBox - VizCombo - VizDonut - VizFunnel - VizGauge - VizHighlight - VizInputTable - VizInputTableLinked - VizKpi - VizLine - VizMap - VizPie - VizPivotTable - VizPlaceholder - VizSankey - VizScatter - VizSingleValue - VizTable - VizTreemap - VizWaterfall - Wand - Webhooks - Workbook - WorkbookForModifiers - WorkbookTemplate - Worksheet - Workspace - X - XCircle - XSquare description: A supported Sigma icon name, e.g. `Document`. title: Icon name variant: oneOf: - type: string enum: - filled - type: string enum: - outlined - type: string enum: - toned description: 'Icon style variant: ''filled'', ''outlined'' (default), or ''toned''.' description: A named icon (by name and style variant). title: Icon description: An emoji or icon. destination: oneOf: - type: object required: - type - pageId properties: type: type: string enum: - page pageId: type: string description: Navigates to the top of a workbook page. title: Page destination - type: object required: - type - elementId properties: type: type: string enum: - element elementId: type: string description: Navigates (anchors) to an element on a page. title: Element destination - allOf: - type: object required: - type - url properties: type: type: string enum: - link url: type: string - type: object properties: openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the link opens: _self (same tab), _blank (new tab, default), or _parent (parent frame).' description: Opens an external URL. title: External link - type: object required: - type properties: type: type: string enum: - none description: The option has no destination. title: No destination description: 'The option''s destination: a workbook ''page'', an ''element'' anchor, an external ''link'', or ''none''.' description: A single navigation menu item. title: Menu item description: A navigation menu item or a submenu of items. description: The navigation options (at least one). - type: object properties: showIcons: type: boolean description: Whether option icons are shown. description: A navigation menu of user-defined options. title: Manual navigation - allOf: - allOf: - type: object required: - id - kind properties: id: type: string description: The identifier of the navigation element. kind: type: string enum: - navigation - type: object properties: style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' optionStyle: type: object properties: style: oneOf: - type: string enum: - line - type: string enum: - pill description: 'Option style: ''line'' (default) or ''pill''.' orientation: oneOf: - type: string enum: - horizontal - type: string enum: - vertical description: 'Layout direction: ''horizontal'' (default) or ''vertical''.' alignment: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right - type: string enum: - justify description: 'Alignment: ''left'' (default), ''center'', ''right'', or ''justify''. ''justify'' only applies to horizontal orientation.' size: oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Size: ''small'', ''medium'' (default), or ''large''.' textColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Label color for unselected options. selectedColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Label + indicator color for the selected option. description: 'Appearance of the option buttons: style, orientation, alignment, size, and colors.' - type: object required: - mode properties: mode: type: string enum: - auto - type: object properties: pageLabels: type: object additionalProperties: type: string description: Per-page label overrides keyed by page id. description: A navigation menu that lists the workbook's pages. title: Auto navigation description: '' title: Navigation - type: object required: - id - kind properties: id: type: string description: The identifier of the page break. kind: type: string enum: - page-break description: '' title: Page break CommonElement: oneOf: - oneOf: - allOf: - type: object required: - id - kind - columns - source properties: id: type: string description: The identifier of the table. kind: type: string enum: - table columns: type: array items: allOf: - allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. - type: object properties: style: type: object properties: align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal alignment of cell content: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment of cell content: start, middle, or end.' width: type: number description: Column width in pixels when overriding auto-sizing. backgroundColor: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Cell background: `{ kind: theme, ref }` or hex `#rgb` / `#rrggbb` only.' color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Cell text color: `{ kind: theme, ref }` or hex only.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip'' (no wrap).' description: Grid presentation for this column (alignment, width, colors, wrap). link: oneOf: - type: object required: - kind - columnId properties: kind: type: string enum: - column columnId: type: string description: External id of a column in this table whose text values are the hyperlink URL. - type: object required: - kind - formula properties: kind: type: string enum: - formula formula: type: string description: Text-typed formula for the hyperlink URL. description: 'Hyperlink target for this column: another column’s text values or a custom URL formula.' description: The columns of the table and their formulas. Optional columns[].style holds grid presentation (enums, not booleans, for toggles). source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The source of the table. - type: object properties: name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. align: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Title alignment: ''start'', ''middle'', or ''end''.' description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`.' description: oneOf: - type: string - type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Table description (subtitle / tooltip text) plus optional styling. noDataText: type: string description: Custom message rendered when the chart has no data. metrics: type: array items: allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the metric. formula: type: string description: The formula defining the metric. - type: object properties: name: type: string description: The name of the metric. description: type: string description: The description of the metric. isHighlighted: type: boolean description: Indicates whether or not the metric is highlighted. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. timeline: allOf: - type: object required: - dateColumnId properties: dateColumnId: type: string description: The column of date data used to create the metric timeline. - type: object properties: truncation: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: The precision to truncate the date to. comparison: allOf: - type: object required: - comparisonPeriod properties: comparisonPeriod: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: The time period to compare the current metric value against. - type: object properties: direction: oneOf: - type: string enum: - higher-is-better - type: string enum: - lower-is-better description: Indicates whether higher or lower comparison values are better for that metric. description: The time period to compare the current metric value against. description: The timeline configuration for the metric. description: The metrics associated with this table and their configurations. relationships: type: array items: allOf: - type: object required: - id - targetElementId - keys properties: id: type: string description: The identifier of the relationship. targetElementId: type: string description: The identifier of the table joined to the parent table in the relationship. keys: type: array items: type: object required: - sourceColumnId - targetColumnId properties: sourceColumnId: type: string description: The column from the parent table joined in this relationship. targetColumnId: type: string description: The column from the target table joined in this relationship. description: The pairs of source and target column IDs joined in this relationship. - type: object properties: name: type: string description: The name of the relationship. description: type: string description: The description of the relationship. description: The relationships sourced from this table and their targets. filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this table and their configurations. folders: type: array items: allOf: - type: object required: - id - name properties: id: type: string description: The identifier of the folder. name: type: string description: The name of the folder. - type: object properties: items: type: array items: type: string description: The column and folder IDs contained within the folder. description: The folders in the table and their contents. groupings: type: array items: allOf: - type: object required: - id properties: id: type: string description: The identifier of the grouping. - type: object properties: groupBy: type: array items: type: string description: The columns or folders that define the grouping. calculations: type: array items: type: string description: The calculations applied to the grouping. description: The groupings in the table and their contents. summary: type: array items: type: string description: The identifiers of all columns in the table that are summaries. order: type: array items: type: string description: A list of identifiers that determines the order in which columns and folders are displayed in the UI. Does not include summary columns. visibleAsSource: type: boolean description: Indicates whether or not the table can be used as a source in other documents. sort: type: array items: allOf: - type: object required: - columnId - direction properties: columnId: type: string description: The identifier of the column by which to sort. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: The direction in which to sort. - type: object properties: nulls: oneOf: - type: string enum: - first - type: string enum: - last - type: string enum: - connection-default description: Indicates how the sort order treats null values. description: The column, direction, and null behavior used to sort the rows of this table. columnSecurities: type: array items: type: object required: - id - restrictedColumns - criteria properties: id: type: string description: The identifier of the column security rule. restrictedColumns: type: array items: type: string description: The list of columns restricted by the column security rule. criteria: oneOf: - type: object required: - kind properties: kind: type: string enum: - no-one-can-view description: '' title: No One Can View - type: object required: - kind - assignments properties: kind: type: string enum: - specific-users-and-teams assignments: type: array items: oneOf: - type: object required: - type - userId properties: type: type: string enum: - user userId: type: string description: The identifier of a Sigma user. description: '' title: User - type: object required: - type - teamId properties: type: type: string enum: - team teamId: type: string description: The identifier of a team. description: '' title: Team description: The identifiers of the users and teams that can access the columns restricted by the column security rule. description: '' title: Specific Users and Teams - type: object required: - kind - assignments properties: kind: type: string enum: - user-attribute assignments: type: array items: type: object required: - userAttributeId - value properties: userAttributeId: type: string description: The identifier of a user attribute. value: type: string description: The value for a user attribute. description: The identifier of a user attribute and the value users must be assigned to view the columns restricted by the column security rule. description: '' title: User Attribute description: A list of the column security rules applied to columns in this table. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' conditionalFormats: type: array items: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - single - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column IDs that this formatting applies to. Must be non-empty. - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - formula properties: condition: type: string enum: - formula formula: type: string description: A Sling formula returning a boolean. The formula may reference any column on the sheet, not just the styled columns. - type: object properties: style: type: object properties: backgroundColor: type: string description: Cell background color (hex). color: type: string description: Font color (hex). bold: type: boolean italic: type: boolean underline: type: boolean format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: Number or datetime format override for the displayed value. - allOf: - type: object required: - type properties: type: type: string enum: - backgroundScale - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column IDs that this formatting applies to. Must be non-empty. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops that define the gradient. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. mid: oneOf: - type: number - type: string description: Domain midpoint. Presence selects a diverging scale; absence is sequential. order: oneOf: - type: string enum: - descending - type: string enum: - ascending nullBehavior: oneOf: - type: string enum: - asZero - type: string enum: - asNull steps: type: number description: Quantize the continuous gradient into N discrete buckets. - allOf: - type: object required: - type properties: type: type: string enum: - fontScale - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column IDs that this formatting applies to. Must be non-empty. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops that define the gradient. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. mid: oneOf: - type: number - type: string description: Domain midpoint. Presence selects a diverging scale; absence is sequential. order: oneOf: - type: string enum: - descending - type: string enum: - ascending nullBehavior: oneOf: - type: string enum: - asZero - type: string enum: - asNull steps: type: number - allOf: - type: object required: - type properties: type: type: string enum: - dataBars - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column IDs that this formatting applies to. Must be non-empty. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops that define the gradient. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. mid: oneOf: - type: number - type: string description: Domain midpoint. Presence selects a diverging scale; absence is sequential. order: oneOf: - type: string enum: - descending - type: string enum: - ascending valueLabels: oneOf: - type: string enum: - hidden - type: string enum: - shown description: 'Conditional formatting applied to columns of this table. Order matters: later entries apply on top of earlier ones.' sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Default sparkline mark formatting applied to all sparkline columns (Format tab apply-to-all). tableComponents: type: object description: Table component visibility toggles (summary bar, collapsed columns, etc.). Each key is `shown` or `hidden`; omit when shown (default). tableStyle: type: object properties: preset: oneOf: - type: string enum: - spreadsheet - type: string enum: - presentation description: 'Table preset: ''spreadsheet'' or ''presentation''. Omit when spreadsheet (default).' cellSpacing: oneOf: - type: string enum: - extra-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Cell spacing preset: ''extra-small'', ''small'', ''medium'', or ''large''.' gridLines: oneOf: - type: string enum: - none - type: string enum: - vertical - type: string enum: - horizontal - type: string enum: - all description: 'Grid lines: ''none'', ''vertical'', ''horizontal'', or ''all''.' banding: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Row banding visibility: ''shown'' or ''hidden''.' bandingColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' autofitColumns: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Autofit column widths (level table only): ''shown'' or ''hidden''.' outerBorder: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Outer table border: ''shown'' or ''hidden''. Maps to inverted store `hideOuterBorder`.' headerDividerColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' heavyVerticalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier vertical group dividers (pivot only): ''shown'' or ''hidden''.' heavyHorizontalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier horizontal group dividers (pivot only): ''shown'' or ''hidden''.' textStyles: type: object properties: header: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' cell: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' columnHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' rowHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' description: 'Table style: grid preset, spacing, grid lines, banding, autofit, dividers, and per-tab text styles.' frozenColumn: oneOf: - allOf: - type: object required: - columnId properties: columnId: type: string description: The column to freeze. This column and any column visually to its left are frozen. - type: object properties: fieldValues: type: object additionalProperties: oneOf: - type: string - type: number - type: boolean - type: 'null' description: Pivot dimension values at the freeze point, keyed by column ID. - type: 'null' description: Frozen column configuration. - type: object properties: actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. description: '' title: Table - allOf: - type: object required: - id - kind - source - columns - value properties: id: type: string description: The identifier of the KPI. kind: type: string enum: - kpi-chart source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the KPI. columns: type: array items: allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. description: The columns used by the KPI. value: allOf: - type: object required: - columnId properties: columnId: type: string description: Column id bound to the KPI value shelf. - type: object properties: visibility: type: string enum: - hidden description: Hide the KPI value number. Only applies when a comparison is configured. Omit when shown. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Value font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: oneOf: - type: number - type: string enum: - auto description: Value font size in pixels, or 'auto'. description: KPI value shelf binding (`columnId`) plus optional Value-section styling. - type: object properties: name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: oneOf: - type: number - type: string enum: - auto description: Title font size in pixels, or 'auto' to let the viz pick. description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size (numeric or `auto`), color, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`. KPI does not support alignment.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: oneOf: - type: number - type: string enum: - auto description: Description font size in pixels, or 'auto' to let the viz pick. description: KPI description (subtitle / tooltip text) plus optional styling. KPI accepts `auto` font size. filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this chart. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' layout: type: object properties: anchor: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Alignment: ''start'', ''middle'', or ''end''.' verticalAnchor: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment: ''start'', ''middle'', or ''end''.' titleOrient: oneOf: - type: string enum: - top - type: string enum: - bottom description: 'Title position: ''top'' or ''bottom''.' comparisonValueOrient: oneOf: - type: string enum: - right - type: string enum: - below description: 'Comparison value position: ''right'' or ''below''.' description: 'KPI layout: alignment, title position, and comparison position.' comparison: type: object properties: display: oneOf: - type: string enum: - percentage - type: string enum: - delta - type: string enum: - relative - type: string enum: - absolute description: 'Comparison display: ''percentage'', ''delta'', ''relative'', or ''absolute''.' direction: oneOf: - type: string enum: - higher - type: string enum: - lower - type: string enum: - none description: 'Comparison direction: ''higher'', ''lower'', or ''none''.' colorGood: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' colorNeutral: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' colorBad: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' arrow: type: string enum: - hidden description: Hide the comparison arrow. Omit when shown. fontSize: oneOf: - type: number - type: string enum: - auto description: Comparison font size in pixels, or 'auto'. label: oneOf: - type: string enum: - hidden - type: string description: Comparison label text, or 'hidden' to hide the label. labelColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' noDateText: type: string description: Label shown when the comparison date is invalid. description: KPI comparison formatting (display, direction, colors, label). trend: type: object properties: visibility: type: string enum: - hidden description: Hide the trend sparkline. Omit when shown. shape: oneOf: - type: string enum: - line - type: string enum: - area description: 'Trend shape: ''line'' or ''area''.' areaStyle: oneOf: - type: string enum: - gradient - type: string enum: - solid description: 'Area fill style: ''gradient'' or ''solid''. Only applies when shape is ''area''.' valueColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' comparisonColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' tooltip: type: string enum: - shown description: Explicitly enable a feature whose default is off. xAxis: type: string enum: - shown description: Explicitly enable a feature whose default is off. yAxis: type: string enum: - shown description: Explicitly enable a feature whose default is off. noDataText: type: string description: Label shown when the trend has no data. description: KPI trend sparkline formatting. timeline: type: object required: - columnId properties: columnId: type: string description: Column id bound to the KPI timeline shelf (enables the trend sparkline). description: KPI timeline shelf binding (date column for the trend sparkline). periodComparison: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Period-over-period comparison grain (requires timeline). Mutually exclusive with comparisonColumn. comparisonColumn: type: object required: - columnId properties: columnId: type: string description: Column id bound to the KPI comparison shelf (compare value to another measure). description: Comparison shelf binding (compare value to another measure). Mutually exclusive with periodComparison. - type: object properties: actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. description: '' title: KPI - allOf: - type: object required: - id - kind - source - columns - yAxis properties: id: type: string description: The identifier of the bar chart. kind: type: string enum: - bar-chart source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the bar chart. columns: type: array items: allOf: - allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. - type: object properties: showOnSegments: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Segment data label visibility: ''shown'' or ''hidden''. Omit when hidden (default).' showOnTotals: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Total data label visibility: ''shown'' or ''hidden''. Omit when shown (default).' description: The columns used by the bar chart. yAxis: allOf: - type: object required: - columnIds properties: columnIds: type: array items: oneOf: - type: string description: Column ID for a Y-axis series. - allOf: - type: object required: - columnId properties: columnId: type: string description: Column ID for a Y-axis series. - type: object properties: type: oneOf: - type: string enum: - bar - type: string enum: - line - type: string enum: - area - type: string enum: - scatter description: 'Per-series chart shape: ''bar'' (default), ''line'', ''area'', or ''scatter''.' description: Column IDs for the Y-axis series. - type: object properties: format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: Y-axis title, labels, marks, and scale formatting. description: The columns used for the Y-axis. - type: object properties: xAxis: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID for the X-axis. - type: object properties: sort: allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: by: type: string description: Column ID to sort by, or "row-count" to sort by number of rows. If omitted, sorts by the column values themselves. aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation function for custom sort. Only valid when "by" references a column ID (not "row-count"). description: Sort order. format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: X-axis title, labels, marks, and scale formatting. description: The column used for the X-axis. name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. align: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Title alignment: ''start'', ''middle'', or ''end''.' description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Chart description (subtitle / tooltip text) plus optional styling. noDataText: type: string description: Custom message rendered when the chart has no data. legend: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the legend. No other fields on this branch. - type: object properties: position: oneOf: - type: string enum: - auto - type: string enum: - top - type: string enum: - right - type: string enum: - bottom - type: string enum: - left - type: string enum: - top-left - type: string enum: - top-right - type: string enum: - bottom-left - type: string enum: - bottom-right description: Legend position. Default 'auto'. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Legend label font size in pixels. colorLegend: type: string enum: - hidden description: Hide the color legend when both color and size legends apply. sizeLegend: type: string enum: - hidden description: Hide the size legend when a size channel is present. header: type: string enum: - hidden description: Hide the legend header row. description: Legend visibility, position, and label styling. tooltip: type: object properties: columnNames: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether column names appear in the tooltip. multiSeries: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the tooltip lists multiple series. Only supported on bar, line, and area charts. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Tooltip value format. Omit when the chart default applies. description: 'Tooltip display options: column names, multiple series, and percent formatting.' stacking: oneOf: - type: string enum: - none - type: string enum: - stacked - type: string enum: - normalized description: 'Stacking mode: ''none'' (side-by-side / overlapping), ''stacked'' (default — values sum), or ''normalized'' (stack scaled to 100%).' orientation: type: string enum: - horizontal description: Bar orientation. Omit (the default) for vertical bars; set to 'horizontal' for horizontal bars. color: oneOf: - type: object required: - by - value properties: by: type: string enum: - single value: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' - allOf: - type: object required: - by - column properties: by: type: string enum: - category column: type: string description: Column id whose values drive the categorical color assignment. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. - allOf: - type: object required: - by - column properties: by: type: string enum: - scale column: type: string description: Numeric column id whose values drive the continuous color gradient. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. domain: type: object properties: min: type: number description: Continuous-scale domain minimum. max: type: number description: Continuous-scale domain maximum. mid: type: number description: Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential. description: 'Color configuration: single hex, categorical column, or continuous gradient.' barStyle: type: object properties: cornerRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Bar corner shape: ''square'' (default), ''round'', or ''pill''.' description: 'Bar corner shape: ''square'' (default), ''round'', or ''pill''.' dataLabel: type: object properties: anchor: oneOf: - type: string enum: - auto - type: string enum: - end - type: string enum: - middle - type: string enum: - outside-end - type: string enum: - start description: Position of the data label relative to its mark. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color used for data label text (hex or theme reference). fontSize: type: number description: Font size for data labels, in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Data-label font weight: ''normal'' or ''bold''.' labelDisplay: oneOf: - type: string enum: - auto - type: string enum: - minimum - type: string enum: - maximum - type: string enum: - min-max - type: string enum: - all description: Which values and labels to show on each bar segment label. labels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. orient: oneOf: - type: string enum: - auto - type: string enum: - horizontal - type: string enum: - vertical description: Text direction for data labels. precision: type: number description: Number of decimal places when labels include percentages. showStroke: oneOf: - type: string enum: - auto - type: string enum: - 'on' - type: string enum: - 'off' description: Outline around data labels. totals: type: object properties: display: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. fontSize: type: number description: Font size for total labels, in pixels. labelDisplay: oneOf: - type: string enum: - auto - type: string enum: - minimum - type: string enum: - maximum - type: string enum: - min-max - type: string enum: - all description: Which values and labels to show on total (aggregate) labels. orient: oneOf: - type: string enum: - horizontal - type: string enum: - vertical description: Text direction for total labels. description: Options for aggregate total labels on bar charts. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Whether numeric values are shown as percentages or as plain numbers. description: Data label typography, placement, and display options. gap: type: object properties: width: oneOf: - type: string enum: - auto - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Gap width between individual bars in a band (format panel: Gap width).' betweenSets: oneOf: - type: string enum: - auto - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Gap between bar clusters when the chart is clustered (format panel: Gap between sets).' description: Bar gap width and spacing between clustered bar sets. filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this chart. backgroundImage: type: object required: - url properties: url: type: string description: The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported). description: Optional plot-area background image. Url supports dynamic-text {{formula}} references. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' refMarks: type: array items: oneOf: - allOf: - type: object required: - type - axis - value properties: type: type: string enum: - line description: Reference line. axis: oneOf: - type: string enum: - axis - type: string enum: - series - type: string enum: - series2 description: 'Axis channel: primary axis (''axis''), primary series (''series''), or secondary series (''series2'').' value: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Position on the axis (constant, column aggregation, or formula). - type: object properties: line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Line color (hex or theme reference). description: Line stroke styling. - type: object properties: label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. annotation: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. description: Computed value label. Omit the block to hide the value (not the mark `value` field). caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and computed-value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and annotation. scope: oneOf: - type: string enum: - chart - type: string enum: - cell description: 'Trellis scope: ''chart'' (shared) or ''cell'' (per panel). Omit for the default shared scope.' - allOf: - type: object required: - type - axis - value - endValue properties: type: type: string enum: - band description: Reference band. axis: oneOf: - type: string enum: - axis - type: string enum: - series - type: string enum: - series2 description: 'Axis channel: primary axis (''axis''), primary series (''series''), or secondary series (''series2'').' value: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Band start position (constant, column aggregation, or formula). endValue: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Band end position (constant, column aggregation, or formula). - type: object properties: line: type: object properties: visibility: type: string enum: - shown description: Band outline visibility. Set to 'shown' to draw the band border. style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Line color (hex or theme reference). description: Band outline stroke styling. fill: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Band fill color (hex or theme reference). description: Band fill color. - type: object properties: label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. annotation: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. description: Computed value label. Omit the block to hide the value (not the mark `value` field). caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and computed-value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and annotation. scope: oneOf: - type: string enum: - chart - type: string enum: - cell description: 'Trellis scope: ''chart'' (shared) or ''cell'' (per panel). Omit for the default shared scope.' description: Reference lines and bands on the chart. trellis: type: object properties: columnsBy: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID placed on this shelf position. - type: object properties: sort: oneOf: - allOf: - type: object required: - type - columnId - direction properties: type: type: string enum: - column description: Sort by another column. columnId: type: string description: Column ID to sort by. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation when sorting by another column. - type: object required: - type - direction properties: type: type: string enum: - row-count description: Sort by row count. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: type: type: string enum: - values description: Sort by this column's own values (default when `type` is omitted). description: 'Custom sort: direction plus optional `type` (`values`, `column`, or `row-count`).' description: Dimension column on the trellis column shelf (category mode). At most one entry; uses pivot shelf array shape. column: type: object properties: border: type: string enum: - hidden description: Set to 'hidden' to hide the row/column border. labels: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Label color: hex or `{ kind: theme, ref }`.' description: 'Facet labels: ''hidden'' or styling overrides.' title: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: text: type: string description: Trellis title text. fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Title color: hex or `{ kind: theme, ref }`.' description: 'Facet title: ''hidden'', or text and styling overrides.' description: Format for the trellis column facet. row: type: object properties: border: type: string enum: - hidden description: Set to 'hidden' to hide the row/column border. labels: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Label color: hex or `{ kind: theme, ref }`.' description: 'Facet labels: ''hidden'' or styling overrides.' title: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: text: type: string description: Trellis title text. fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Title color: hex or `{ kind: theme, ref }`.' description: 'Facet title: ''hidden'', or text and styling overrides.' description: Format for the trellis row facet. rowsBy: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID placed on this shelf position. - type: object properties: sort: oneOf: - allOf: - type: object required: - type - columnId - direction properties: type: type: string enum: - column description: Sort by another column. columnId: type: string description: Column ID to sort by. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation when sorting by another column. - type: object required: - type - direction properties: type: type: string enum: - row-count description: Sort by row count. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: type: type: string enum: - values description: Sort by this column's own values (default when `type` is omitted). description: 'Custom sort: direction plus optional `type` (`values`, `column`, or `row-count`).' description: Dimension column on the trellis row shelf (category mode). At most one entry; uses pivot shelf array shape. series: oneOf: - type: string enum: - row - type: string enum: - column description: Trellis by series direction. Mutually exclusive with `rowsBy` / `columnsBy`. share: type: object properties: color-legends: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share color legends across the trellis grid. Omit when 'shared' (default). size-legends: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share size legends across panels. Omit when 'shared'. Scatter with a size channel only. x-axis: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the category-axis scale across panels (UI label follows chart orientation). y-axis: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the series-axis scale across panels (UI label follows chart orientation). y-axis-2: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the second series-axis scale. Combo charts with a second value axis only. description: Shared scales and legends across trellis panels. tileSize: oneOf: - type: string enum: - auto - type: string enum: - compact description: Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series. description: Trellis bindings (rowsBy, columnsBy, series), tile size, facet styling, and shared scales/legends. trendlines: type: array items: allOf: - type: object required: - columnId - model properties: columnId: type: string description: Series column id (Y-axis) to fit the trend line to. model: oneOf: - type: string enum: - linear - type: string enum: - quadratic - type: string enum: - polynomial - type: string enum: - exponential - type: string enum: - logarithmic - type: string enum: - power description: 'Regression model matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power.' - type: object properties: degree: type: number description: Polynomial degree (3–7). Required when model is 'polynomial'. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Trend line stroke styling. label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `value` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. value: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `value` block entirely to hide it. description: Regression fit value (R²). Omit the block to hide the value. caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and value annotations. description: Regression trend lines on the chart. - type: object properties: actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. description: '' title: Bar Chart - oneOf: - allOf: - type: object required: - id - kind - source - columns - color - value properties: id: type: string description: The identifier of the pie chart. kind: type: string enum: - pie-chart source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the chart. columns: type: array items: allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. description: The columns used by the chart. color: allOf: - type: object required: - id properties: id: type: string description: The column ID. - type: object properties: sort: allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: by: type: string description: Column ID to sort by, or "row-count" to sort by number of rows. If omitted, sorts by the column values themselves. aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation function for custom sort. Only valid when "by" references a column ID (not "row-count"). description: Sort order. description: The column for the categorical split (slice labels). value: type: object required: - id properties: id: type: string description: The column ID. description: The column for the slice size. - type: object properties: name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. align: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Title alignment: ''start'', ''middle'', or ''end''.' description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Chart description (subtitle / tooltip text) plus optional styling. dataLabel: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color used for data label text (hex or theme reference). donutLabelDisplay: oneOf: - type: string enum: - as-label - type: string enum: - on-legend description: Whether donut or pie slice labels appear on the slice or in the legend. fontSize: type: number description: Font size for data labels, in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Data-label font weight: ''normal'' or ''bold''.' labelDisplay: oneOf: - type: string enum: - color - type: string enum: - value - type: string enum: - percent - type: string enum: - color-value - type: string enum: - color-percent - type: string enum: - value-percent - type: string enum: - all description: Which values and labels to show on each slice label. labels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. precision: type: number description: Number of decimal places when labels include percentages. description: Data label typography, placement, and display options for slice values. noDataText: type: string description: Custom message rendered when the chart has no data. legend: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the legend. No other fields on this branch. - type: object properties: position: oneOf: - type: string enum: - auto - type: string enum: - top - type: string enum: - right - type: string enum: - bottom - type: string enum: - left - type: string enum: - top-left - type: string enum: - top-right - type: string enum: - bottom-left - type: string enum: - bottom-right description: Legend position. Default 'auto'. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Legend label font size in pixels. colorLegend: type: string enum: - hidden description: Hide the color legend when both color and size legends apply. sizeLegend: type: string enum: - hidden description: Hide the size legend when a size channel is present. header: type: string enum: - hidden description: Hide the legend header row. description: Legend visibility, position, and label styling. tooltip: type: object properties: columnNames: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether column names appear in the tooltip. multiSeries: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the tooltip lists multiple series. Only supported on bar, line, and area charts. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Tooltip value format. Omit when the chart default applies. description: 'Tooltip display options: column names, multiple series, and percent formatting.' filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this chart. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. - allOf: - type: object required: - id - kind - source - columns - color - value properties: id: type: string description: The identifier of the donut chart. kind: type: string enum: - donut-chart source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the chart. columns: type: array items: allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. description: The columns used by the chart. color: allOf: - type: object required: - id properties: id: type: string description: The column ID. - type: object properties: sort: allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: by: type: string description: Column ID to sort by, or "row-count" to sort by number of rows. If omitted, sorts by the column values themselves. aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation function for custom sort. Only valid when "by" references a column ID (not "row-count"). description: Sort order. description: The column for the categorical split (slice labels). value: type: object required: - id properties: id: type: string description: The column ID. description: The column for the slice size. - type: object properties: name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. align: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Title alignment: ''start'', ''middle'', or ''end''.' description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Chart description (subtitle / tooltip text) plus optional styling. dataLabel: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color used for data label text (hex or theme reference). donutLabelDisplay: oneOf: - type: string enum: - as-label - type: string enum: - on-legend description: Whether donut or pie slice labels appear on the slice or in the legend. fontSize: type: number description: Font size for data labels, in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Data-label font weight: ''normal'' or ''bold''.' labelDisplay: oneOf: - type: string enum: - color - type: string enum: - value - type: string enum: - percent - type: string enum: - color-value - type: string enum: - color-percent - type: string enum: - value-percent - type: string enum: - all description: Which values and labels to show on each slice label. labels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. precision: type: number description: Number of decimal places when labels include percentages. description: Data label typography, placement, and display options for slice values. noDataText: type: string description: Custom message rendered when the chart has no data. legend: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the legend. No other fields on this branch. - type: object properties: position: oneOf: - type: string enum: - auto - type: string enum: - top - type: string enum: - right - type: string enum: - bottom - type: string enum: - left - type: string enum: - top-left - type: string enum: - top-right - type: string enum: - bottom-left - type: string enum: - bottom-right description: Legend position. Default 'auto'. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Legend label font size in pixels. colorLegend: type: string enum: - hidden description: Hide the color legend when both color and size legends apply. sizeLegend: type: string enum: - hidden description: Hide the size legend when a size channel is present. header: type: string enum: - hidden description: Hide the legend header row. description: Legend visibility, position, and label styling. tooltip: type: object properties: columnNames: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether column names appear in the tooltip. multiSeries: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the tooltip lists multiple series. Only supported on bar, line, and area charts. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Tooltip value format. Omit when the chart default applies. description: 'Tooltip display options: column names, multiple series, and percent formatting.' filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this chart. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. holeValue: type: object required: - id properties: id: type: string description: The column ID. description: Optional column for the donut hole KPI value. hole: type: object properties: value: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Hole value visibility. Omit when shown (default). fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Hole value font size in pixels. title: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Hole title visibility. Omit when shown (default). text: type: string description: Hole title text. wrap: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Text wrap: ''shown'' to wrap, ''hidden'' for single line.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Hole title font size in pixels. position: oneOf: - type: string enum: - top - type: string enum: - bottom description: 'Donut hole title position: ''top'' or ''bottom''.' description: Donut hole center title and value styling. innerRadius: type: number description: Donut hole size as a ratio of the outer radius (typically 0.4–0.8). Omit when default (0.6). trellis: type: object properties: columnsBy: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID placed on this shelf position. - type: object properties: sort: oneOf: - allOf: - type: object required: - type - columnId - direction properties: type: type: string enum: - column description: Sort by another column. columnId: type: string description: Column ID to sort by. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation when sorting by another column. - type: object required: - type - direction properties: type: type: string enum: - row-count description: Sort by row count. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: type: type: string enum: - values description: Sort by this column's own values (default when `type` is omitted). description: 'Custom sort: direction plus optional `type` (`values`, `column`, or `row-count`).' description: Dimension column on the trellis column shelf (category mode). At most one entry; uses pivot shelf array shape. column: type: object properties: border: type: string enum: - hidden description: Set to 'hidden' to hide the row/column border. labels: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Label color: hex or `{ kind: theme, ref }`.' description: 'Facet labels: ''hidden'' or styling overrides.' title: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: text: type: string description: Trellis title text. fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Title color: hex or `{ kind: theme, ref }`.' description: 'Facet title: ''hidden'', or text and styling overrides.' description: Format for the trellis column facet. row: type: object properties: border: type: string enum: - hidden description: Set to 'hidden' to hide the row/column border. labels: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Label color: hex or `{ kind: theme, ref }`.' description: 'Facet labels: ''hidden'' or styling overrides.' title: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: text: type: string description: Trellis title text. fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Title color: hex or `{ kind: theme, ref }`.' description: 'Facet title: ''hidden'', or text and styling overrides.' description: Format for the trellis row facet. rowsBy: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID placed on this shelf position. - type: object properties: sort: oneOf: - allOf: - type: object required: - type - columnId - direction properties: type: type: string enum: - column description: Sort by another column. columnId: type: string description: Column ID to sort by. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation when sorting by another column. - type: object required: - type - direction properties: type: type: string enum: - row-count description: Sort by row count. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: type: type: string enum: - values description: Sort by this column's own values (default when `type` is omitted). description: 'Custom sort: direction plus optional `type` (`values`, `column`, or `row-count`).' description: Dimension column on the trellis row shelf (category mode). At most one entry; uses pivot shelf array shape. series: oneOf: - type: string enum: - row - type: string enum: - column description: Trellis by series direction. Mutually exclusive with `rowsBy` / `columnsBy`. share: type: object properties: color-legends: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share color legends across the trellis grid. Omit when 'shared' (default). size-legends: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share size legends across panels. Omit when 'shared'. Scatter with a size channel only. x-axis: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the category-axis scale across panels (UI label follows chart orientation). y-axis: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the series-axis scale across panels (UI label follows chart orientation). y-axis-2: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the second series-axis scale. Combo charts with a second value axis only. description: Shared scales and legends across trellis panels. tileSize: oneOf: - type: string enum: - auto - type: string enum: - compact description: Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series. description: Trellis bindings (rowsBy, columnsBy, series), tile size, facet styling, and shared scales/legends. description: '' title: Donut/Pie Chart - allOf: - type: object required: - id - kind - source - columns - yAxis properties: id: type: string description: The identifier of the line chart. kind: type: string enum: - line-chart source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the line chart. columns: type: array items: allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. description: The columns used by the line chart. yAxis: allOf: - type: object required: - columnIds properties: columnIds: type: array items: oneOf: - type: string description: Column ID for a Y-axis series. - allOf: - type: object required: - columnId properties: columnId: type: string description: Column ID for a Y-axis series. - type: object properties: type: oneOf: - type: string enum: - bar - type: string enum: - line - type: string enum: - area - type: string enum: - scatter description: 'Per-series chart shape: ''bar'' (default), ''line'', ''area'', or ''scatter''.' description: Column IDs for the Y-axis series. - type: object properties: format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: Y-axis title, labels, marks, and scale formatting. description: The columns used for the Y-axis. - type: object properties: xAxis: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID for the X-axis. - type: object properties: sort: allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: by: type: string description: Column ID to sort by, or "row-count" to sort by number of rows. If omitted, sorts by the column values themselves. aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation function for custom sort. Only valid when "by" references a column ID (not "row-count"). description: Sort order. format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: X-axis title, labels, marks, and scale formatting. description: The column used for the X-axis. name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. align: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Title alignment: ''start'', ''middle'', or ''end''.' description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Chart description (subtitle / tooltip text) plus optional styling. noDataText: type: string description: Custom message rendered when the chart has no data. legend: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the legend. No other fields on this branch. - type: object properties: position: oneOf: - type: string enum: - auto - type: string enum: - top - type: string enum: - right - type: string enum: - bottom - type: string enum: - left - type: string enum: - top-left - type: string enum: - top-right - type: string enum: - bottom-left - type: string enum: - bottom-right description: Legend position. Default 'auto'. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Legend label font size in pixels. colorLegend: type: string enum: - hidden description: Hide the color legend when both color and size legends apply. sizeLegend: type: string enum: - hidden description: Hide the size legend when a size channel is present. header: type: string enum: - hidden description: Hide the legend header row. description: Legend visibility, position, and label styling. tooltip: type: object properties: columnNames: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether column names appear in the tooltip. multiSeries: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the tooltip lists multiple series. Only supported on bar, line, and area charts. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Tooltip value format. Omit when the chart default applies. description: 'Tooltip display options: column names, multiple series, and percent formatting.' filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this chart. color: oneOf: - type: object required: - by - value properties: by: type: string enum: - single value: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' - allOf: - type: object required: - by - column properties: by: type: string enum: - category column: type: string description: Column id whose values drive the categorical color assignment. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. - allOf: - type: object required: - by - column properties: by: type: string enum: - scale column: type: string description: Numeric column id whose values drive the continuous color gradient. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. domain: type: object properties: min: type: number description: Continuous-scale domain minimum. max: type: number description: Continuous-scale domain maximum. mid: type: number description: Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential. description: 'Color configuration: single hex, categorical column, or continuous gradient.' dataLabel: type: object properties: clearance: oneOf: - type: string enum: - separated - type: string enum: - default description: Spacing between data labels and neighboring marks when labels could overlap lines or areas. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color used for data label text (hex or theme reference). fontSize: type: number description: Font size for data labels, in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Data-label font weight: ''normal'' or ''bold''.' labelDisplay: oneOf: - type: string enum: - auto - type: string enum: - minimum - type: string enum: - maximum - type: string enum: - min-max - type: string enum: - endpoints - type: string enum: - most-recent - type: string enum: - all-points description: Which values and labels to show on each line point label. labels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. description: Data label typography, placement, and display options. lineAreaStyle: type: object properties: interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Area outline visibility. Omit when shown; only 'hidden' is emitted on read. Not valid on line-chart. style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke and (on area charts) area outline visibility. points: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Point markers. Omit when shown; only 'hidden' is emitted on read. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on the series. description: Line interpolation, stroke, point markers, and null handling for the series. backgroundImage: type: object required: - url properties: url: type: string description: The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported). description: Optional plot-area background image. Url supports dynamic-text {{formula}} references. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' refMarks: type: array items: oneOf: - allOf: - type: object required: - type - axis - value properties: type: type: string enum: - line description: Reference line. axis: oneOf: - type: string enum: - axis - type: string enum: - series - type: string enum: - series2 description: 'Axis channel: primary axis (''axis''), primary series (''series''), or secondary series (''series2'').' value: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Position on the axis (constant, column aggregation, or formula). - type: object properties: line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Line color (hex or theme reference). description: Line stroke styling. - type: object properties: label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. annotation: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. description: Computed value label. Omit the block to hide the value (not the mark `value` field). caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and computed-value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and annotation. scope: oneOf: - type: string enum: - chart - type: string enum: - cell description: 'Trellis scope: ''chart'' (shared) or ''cell'' (per panel). Omit for the default shared scope.' - allOf: - type: object required: - type - axis - value - endValue properties: type: type: string enum: - band description: Reference band. axis: oneOf: - type: string enum: - axis - type: string enum: - series - type: string enum: - series2 description: 'Axis channel: primary axis (''axis''), primary series (''series''), or secondary series (''series2'').' value: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Band start position (constant, column aggregation, or formula). endValue: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Band end position (constant, column aggregation, or formula). - type: object properties: line: type: object properties: visibility: type: string enum: - shown description: Band outline visibility. Set to 'shown' to draw the band border. style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Line color (hex or theme reference). description: Band outline stroke styling. fill: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Band fill color (hex or theme reference). description: Band fill color. - type: object properties: label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. annotation: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. description: Computed value label. Omit the block to hide the value (not the mark `value` field). caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and computed-value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and annotation. scope: oneOf: - type: string enum: - chart - type: string enum: - cell description: 'Trellis scope: ''chart'' (shared) or ''cell'' (per panel). Omit for the default shared scope.' description: Reference lines and bands on the chart. trellis: type: object properties: columnsBy: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID placed on this shelf position. - type: object properties: sort: oneOf: - allOf: - type: object required: - type - columnId - direction properties: type: type: string enum: - column description: Sort by another column. columnId: type: string description: Column ID to sort by. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation when sorting by another column. - type: object required: - type - direction properties: type: type: string enum: - row-count description: Sort by row count. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: type: type: string enum: - values description: Sort by this column's own values (default when `type` is omitted). description: 'Custom sort: direction plus optional `type` (`values`, `column`, or `row-count`).' description: Dimension column on the trellis column shelf (category mode). At most one entry; uses pivot shelf array shape. column: type: object properties: border: type: string enum: - hidden description: Set to 'hidden' to hide the row/column border. labels: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Label color: hex or `{ kind: theme, ref }`.' description: 'Facet labels: ''hidden'' or styling overrides.' title: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: text: type: string description: Trellis title text. fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Title color: hex or `{ kind: theme, ref }`.' description: 'Facet title: ''hidden'', or text and styling overrides.' description: Format for the trellis column facet. row: type: object properties: border: type: string enum: - hidden description: Set to 'hidden' to hide the row/column border. labels: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Label color: hex or `{ kind: theme, ref }`.' description: 'Facet labels: ''hidden'' or styling overrides.' title: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: text: type: string description: Trellis title text. fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Title color: hex or `{ kind: theme, ref }`.' description: 'Facet title: ''hidden'', or text and styling overrides.' description: Format for the trellis row facet. rowsBy: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID placed on this shelf position. - type: object properties: sort: oneOf: - allOf: - type: object required: - type - columnId - direction properties: type: type: string enum: - column description: Sort by another column. columnId: type: string description: Column ID to sort by. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation when sorting by another column. - type: object required: - type - direction properties: type: type: string enum: - row-count description: Sort by row count. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: type: type: string enum: - values description: Sort by this column's own values (default when `type` is omitted). description: 'Custom sort: direction plus optional `type` (`values`, `column`, or `row-count`).' description: Dimension column on the trellis row shelf (category mode). At most one entry; uses pivot shelf array shape. series: oneOf: - type: string enum: - row - type: string enum: - column description: Trellis by series direction. Mutually exclusive with `rowsBy` / `columnsBy`. share: type: object properties: color-legends: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share color legends across the trellis grid. Omit when 'shared' (default). size-legends: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share size legends across panels. Omit when 'shared'. Scatter with a size channel only. x-axis: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the category-axis scale across panels (UI label follows chart orientation). y-axis: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the series-axis scale across panels (UI label follows chart orientation). y-axis-2: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the second series-axis scale. Combo charts with a second value axis only. description: Shared scales and legends across trellis panels. tileSize: oneOf: - type: string enum: - auto - type: string enum: - compact description: Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series. description: Trellis bindings (rowsBy, columnsBy, series), tile size, facet styling, and shared scales/legends. trendlines: type: array items: allOf: - type: object required: - columnId - model properties: columnId: type: string description: Series column id (Y-axis) to fit the trend line to. model: oneOf: - type: string enum: - linear - type: string enum: - quadratic - type: string enum: - polynomial - type: string enum: - exponential - type: string enum: - logarithmic - type: string enum: - power description: 'Regression model matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power.' - type: object properties: degree: type: number description: Polynomial degree (3–7). Required when model is 'polynomial'. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Trend line stroke styling. label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `value` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. value: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `value` block entirely to hide it. description: Regression fit value (R²). Omit the block to hide the value. caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and value annotations. description: Regression trend lines on the chart. - type: object properties: actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. description: '' title: Line Chart - allOf: - type: object required: - id - kind - source - columns - yAxis properties: id: type: string description: The identifier of the area chart. kind: type: string enum: - area-chart source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the area chart. columns: type: array items: allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. description: The columns used by the area chart. yAxis: allOf: - type: object required: - columnIds properties: columnIds: type: array items: oneOf: - type: string description: Column ID for a Y-axis series. - allOf: - type: object required: - columnId properties: columnId: type: string description: Column ID for a Y-axis series. - type: object properties: type: oneOf: - type: string enum: - bar - type: string enum: - line - type: string enum: - area - type: string enum: - scatter description: 'Per-series chart shape: ''bar'' (default), ''line'', ''area'', or ''scatter''.' description: Column IDs for the Y-axis series. - type: object properties: format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: Y-axis title, labels, marks, and scale formatting. description: The columns used for the Y-axis. - type: object properties: xAxis: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID for the X-axis. - type: object properties: sort: allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: by: type: string description: Column ID to sort by, or "row-count" to sort by number of rows. If omitted, sorts by the column values themselves. aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation function for custom sort. Only valid when "by" references a column ID (not "row-count"). description: Sort order. format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: X-axis title, labels, marks, and scale formatting. description: The column used for the X-axis. name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. align: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Title alignment: ''start'', ''middle'', or ''end''.' description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Chart description (subtitle / tooltip text) plus optional styling. noDataText: type: string description: Custom message rendered when the chart has no data. legend: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the legend. No other fields on this branch. - type: object properties: position: oneOf: - type: string enum: - auto - type: string enum: - top - type: string enum: - right - type: string enum: - bottom - type: string enum: - left - type: string enum: - top-left - type: string enum: - top-right - type: string enum: - bottom-left - type: string enum: - bottom-right description: Legend position. Default 'auto'. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Legend label font size in pixels. colorLegend: type: string enum: - hidden description: Hide the color legend when both color and size legends apply. sizeLegend: type: string enum: - hidden description: Hide the size legend when a size channel is present. header: type: string enum: - hidden description: Hide the legend header row. description: Legend visibility, position, and label styling. tooltip: type: object properties: columnNames: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether column names appear in the tooltip. multiSeries: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the tooltip lists multiple series. Only supported on bar, line, and area charts. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Tooltip value format. Omit when the chart default applies. description: 'Tooltip display options: column names, multiple series, and percent formatting.' stacking: oneOf: - type: string enum: - none - type: string enum: - stacked - type: string enum: - normalized description: 'Stacking mode: ''none'' (side-by-side / overlapping), ''stacked'' (default — values sum), or ''normalized'' (stack scaled to 100%).' color: oneOf: - type: object required: - by - value properties: by: type: string enum: - single value: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' - allOf: - type: object required: - by - column properties: by: type: string enum: - category column: type: string description: Column id whose values drive the categorical color assignment. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. - allOf: - type: object required: - by - column properties: by: type: string enum: - scale column: type: string description: Numeric column id whose values drive the continuous color gradient. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. domain: type: object properties: min: type: number description: Continuous-scale domain minimum. max: type: number description: Continuous-scale domain maximum. mid: type: number description: Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential. description: 'Color configuration: single hex, categorical column, or continuous gradient.' dataLabel: type: object properties: clearance: oneOf: - type: string enum: - separated - type: string enum: - default description: Spacing between data labels and neighboring marks when labels could overlap lines or areas. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color used for data label text (hex or theme reference). fontSize: type: number description: Font size for data labels, in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Data-label font weight: ''normal'' or ''bold''.' labelDisplay: oneOf: - type: string enum: - auto - type: string enum: - minimum - type: string enum: - maximum - type: string enum: - min-max - type: string enum: - endpoints - type: string enum: - most-recent - type: string enum: - all-points description: Which values and labels to show on each area series label. labels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. description: Data label typography, placement, and display options. lineAreaStyle: type: object properties: interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Area outline visibility. Omit when shown; only 'hidden' is emitted on read. Not valid on line-chart. style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke and (on area charts) area outline visibility. points: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Point markers. Omit when shown; only 'hidden' is emitted on read. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on the series. description: Interpolation, area outline, stroke, point markers, and null handling. filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this chart. backgroundImage: type: object required: - url properties: url: type: string description: The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported). description: Optional plot-area background image. Url supports dynamic-text {{formula}} references. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' trellis: type: object properties: columnsBy: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID placed on this shelf position. - type: object properties: sort: oneOf: - allOf: - type: object required: - type - columnId - direction properties: type: type: string enum: - column description: Sort by another column. columnId: type: string description: Column ID to sort by. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation when sorting by another column. - type: object required: - type - direction properties: type: type: string enum: - row-count description: Sort by row count. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: type: type: string enum: - values description: Sort by this column's own values (default when `type` is omitted). description: 'Custom sort: direction plus optional `type` (`values`, `column`, or `row-count`).' description: Dimension column on the trellis column shelf (category mode). At most one entry; uses pivot shelf array shape. column: type: object properties: border: type: string enum: - hidden description: Set to 'hidden' to hide the row/column border. labels: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Label color: hex or `{ kind: theme, ref }`.' description: 'Facet labels: ''hidden'' or styling overrides.' title: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: text: type: string description: Trellis title text. fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Title color: hex or `{ kind: theme, ref }`.' description: 'Facet title: ''hidden'', or text and styling overrides.' description: Format for the trellis column facet. row: type: object properties: border: type: string enum: - hidden description: Set to 'hidden' to hide the row/column border. labels: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Label color: hex or `{ kind: theme, ref }`.' description: 'Facet labels: ''hidden'' or styling overrides.' title: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: text: type: string description: Trellis title text. fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Title color: hex or `{ kind: theme, ref }`.' description: 'Facet title: ''hidden'', or text and styling overrides.' description: Format for the trellis row facet. rowsBy: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID placed on this shelf position. - type: object properties: sort: oneOf: - allOf: - type: object required: - type - columnId - direction properties: type: type: string enum: - column description: Sort by another column. columnId: type: string description: Column ID to sort by. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation when sorting by another column. - type: object required: - type - direction properties: type: type: string enum: - row-count description: Sort by row count. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: type: type: string enum: - values description: Sort by this column's own values (default when `type` is omitted). description: 'Custom sort: direction plus optional `type` (`values`, `column`, or `row-count`).' description: Dimension column on the trellis row shelf (category mode). At most one entry; uses pivot shelf array shape. series: oneOf: - type: string enum: - row - type: string enum: - column description: Trellis by series direction. Mutually exclusive with `rowsBy` / `columnsBy`. share: type: object properties: color-legends: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share color legends across the trellis grid. Omit when 'shared' (default). size-legends: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share size legends across panels. Omit when 'shared'. Scatter with a size channel only. x-axis: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the category-axis scale across panels (UI label follows chart orientation). y-axis: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the series-axis scale across panels (UI label follows chart orientation). y-axis-2: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the second series-axis scale. Combo charts with a second value axis only. description: Shared scales and legends across trellis panels. tileSize: oneOf: - type: string enum: - auto - type: string enum: - compact description: Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series. description: Trellis bindings (rowsBy, columnsBy, series), tile size, facet styling, and shared scales/legends. trendlines: type: array items: allOf: - type: object required: - columnId - model properties: columnId: type: string description: Series column id (Y-axis) to fit the trend line to. model: oneOf: - type: string enum: - linear - type: string enum: - quadratic - type: string enum: - polynomial - type: string enum: - exponential - type: string enum: - logarithmic - type: string enum: - power description: 'Regression model matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power.' - type: object properties: degree: type: number description: Polynomial degree (3–7). Required when model is 'polynomial'. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Trend line stroke styling. label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `value` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. value: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `value` block entirely to hide it. description: Regression fit value (R²). Omit the block to hide the value. caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and value annotations. description: Regression trend lines on the chart. refMarks: type: array items: oneOf: - allOf: - type: object required: - type - axis - value properties: type: type: string enum: - line description: Reference line. axis: oneOf: - type: string enum: - axis - type: string enum: - series - type: string enum: - series2 description: 'Axis channel: primary axis (''axis''), primary series (''series''), or secondary series (''series2'').' value: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Position on the axis (constant, column aggregation, or formula). - type: object properties: line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Line color (hex or theme reference). description: Line stroke styling. - type: object properties: label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. annotation: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. description: Computed value label. Omit the block to hide the value (not the mark `value` field). caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and computed-value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and annotation. scope: oneOf: - type: string enum: - chart - type: string enum: - cell description: 'Trellis scope: ''chart'' (shared) or ''cell'' (per panel). Omit for the default shared scope.' - allOf: - type: object required: - type - axis - value - endValue properties: type: type: string enum: - band description: Reference band. axis: oneOf: - type: string enum: - axis - type: string enum: - series - type: string enum: - series2 description: 'Axis channel: primary axis (''axis''), primary series (''series''), or secondary series (''series2'').' value: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Band start position (constant, column aggregation, or formula). endValue: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Band end position (constant, column aggregation, or formula). - type: object properties: line: type: object properties: visibility: type: string enum: - shown description: Band outline visibility. Set to 'shown' to draw the band border. style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Line color (hex or theme reference). description: Band outline stroke styling. fill: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Band fill color (hex or theme reference). description: Band fill color. - type: object properties: label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. annotation: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. description: Computed value label. Omit the block to hide the value (not the mark `value` field). caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and computed-value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and annotation. scope: oneOf: - type: string enum: - chart - type: string enum: - cell description: 'Trellis scope: ''chart'' (shared) or ''cell'' (per panel). Omit for the default shared scope.' description: Reference lines and bands on the chart. - type: object properties: actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. description: '' title: Area Chart - allOf: - type: object required: - id - kind - source - columns - yAxis properties: id: type: string description: The identifier of the scatter chart. kind: type: string enum: - scatter-chart source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the scatter chart. columns: type: array items: allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. description: The columns used by the scatter chart. yAxis: allOf: - type: object required: - columnIds properties: columnIds: type: array items: oneOf: - type: string description: Column ID for a Y-axis series. - allOf: - type: object required: - columnId properties: columnId: type: string description: Column ID for a Y-axis series. - type: object properties: type: oneOf: - type: string enum: - bar - type: string enum: - line - type: string enum: - area - type: string enum: - scatter description: 'Per-series chart shape: ''bar'' (default), ''line'', ''area'', or ''scatter''.' description: Column IDs for the Y-axis series. - type: object properties: format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: Y-axis title, labels, marks, and scale formatting. description: The columns used for the Y-axis. Most scatter plots have one Y-axis column; multiple turn on a series-per-column scatter. - type: object properties: xAxis: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID for the X-axis. - type: object properties: sort: allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: by: type: string description: Column ID to sort by, or "row-count" to sort by number of rows. If omitted, sorts by the column values themselves. aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation function for custom sort. Only valid when "by" references a column ID (not "row-count"). description: Sort order. format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: X-axis title, labels, marks, and scale formatting. description: The column used for the X-axis. size: type: object required: - id properties: id: type: string description: The column ID. description: Optional column whose values drive the bubble size. color: oneOf: - type: object required: - by - value properties: by: type: string enum: - single value: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' - allOf: - type: object required: - by - column properties: by: type: string enum: - category column: type: string description: Column id whose values drive the categorical color assignment. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. - allOf: - type: object required: - by - column properties: by: type: string enum: - scale column: type: string description: Numeric column id whose values drive the continuous color gradient. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. domain: type: object properties: min: type: number description: Continuous-scale domain minimum. max: type: number description: Continuous-scale domain maximum. mid: type: number description: Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential. description: 'Color configuration: single hex, categorical column, or continuous gradient.' dataLabel: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color used for data label text (hex or theme reference). fontSize: type: number description: Font size for data labels, in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Data-label font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. precision: type: number description: Number of decimal places when labels use percent format. showStroke: oneOf: - type: string enum: - auto - type: string enum: - 'on' - type: string enum: - 'off' description: Outline around data labels. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Whether numeric values are shown as percentages or as plain numbers. description: Data label typography, placement, and display options. name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. align: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Title alignment: ''start'', ''middle'', or ''end''.' description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Chart description (subtitle / tooltip text) plus optional styling. noDataText: type: string description: Custom message rendered when the chart has no data. legend: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the legend. No other fields on this branch. - type: object properties: position: oneOf: - type: string enum: - auto - type: string enum: - top - type: string enum: - right - type: string enum: - bottom - type: string enum: - left - type: string enum: - top-left - type: string enum: - top-right - type: string enum: - bottom-left - type: string enum: - bottom-right description: Legend position. Default 'auto'. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Legend label font size in pixels. colorLegend: type: string enum: - hidden description: Hide the color legend when both color and size legends apply. sizeLegend: type: string enum: - hidden description: Hide the size legend when a size channel is present. header: type: string enum: - hidden description: Hide the legend header row. description: Legend visibility, position, and label styling. tooltip: type: object properties: columnNames: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether column names appear in the tooltip. multiSeries: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the tooltip lists multiple series. Only supported on bar, line, and area charts. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Tooltip value format. Omit when the chart default applies. description: 'Tooltip display options: column names, multiple series, and percent formatting.' filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this chart. backgroundImage: type: object required: - url properties: url: type: string description: The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported). description: Optional plot-area background image. Url supports dynamic-text {{formula}} references. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' pointStyle: type: object properties: shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. - oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: Point size preset when a size channel is bound. Maps to store area values (Small/Medium/Large in the format panel). description: Point marker shape and size for the format-panel Point style section. refMarks: type: array items: oneOf: - allOf: - type: object required: - type - axis - value properties: type: type: string enum: - line description: Reference line. axis: oneOf: - type: string enum: - axis - type: string enum: - series - type: string enum: - series2 description: 'Axis channel: primary axis (''axis''), primary series (''series''), or secondary series (''series2'').' value: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Position on the axis (constant, column aggregation, or formula). - type: object properties: line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Line color (hex or theme reference). description: Line stroke styling. - type: object properties: label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. annotation: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. description: Computed value label. Omit the block to hide the value (not the mark `value` field). caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and computed-value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and annotation. scope: oneOf: - type: string enum: - chart - type: string enum: - cell description: 'Trellis scope: ''chart'' (shared) or ''cell'' (per panel). Omit for the default shared scope.' - allOf: - type: object required: - type - axis - value - endValue properties: type: type: string enum: - band description: Reference band. axis: oneOf: - type: string enum: - axis - type: string enum: - series - type: string enum: - series2 description: 'Axis channel: primary axis (''axis''), primary series (''series''), or secondary series (''series2'').' value: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Band start position (constant, column aggregation, or formula). endValue: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Band end position (constant, column aggregation, or formula). - type: object properties: line: type: object properties: visibility: type: string enum: - shown description: Band outline visibility. Set to 'shown' to draw the band border. style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Line color (hex or theme reference). description: Band outline stroke styling. fill: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Band fill color (hex or theme reference). description: Band fill color. - type: object properties: label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. annotation: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. description: Computed value label. Omit the block to hide the value (not the mark `value` field). caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and computed-value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and annotation. scope: oneOf: - type: string enum: - chart - type: string enum: - cell description: 'Trellis scope: ''chart'' (shared) or ''cell'' (per panel). Omit for the default shared scope.' description: Reference lines and bands on the chart. trellis: type: object properties: columnsBy: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID placed on this shelf position. - type: object properties: sort: oneOf: - allOf: - type: object required: - type - columnId - direction properties: type: type: string enum: - column description: Sort by another column. columnId: type: string description: Column ID to sort by. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation when sorting by another column. - type: object required: - type - direction properties: type: type: string enum: - row-count description: Sort by row count. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: type: type: string enum: - values description: Sort by this column's own values (default when `type` is omitted). description: 'Custom sort: direction plus optional `type` (`values`, `column`, or `row-count`).' description: Dimension column on the trellis column shelf (category mode). At most one entry; uses pivot shelf array shape. column: type: object properties: border: type: string enum: - hidden description: Set to 'hidden' to hide the row/column border. labels: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Label color: hex or `{ kind: theme, ref }`.' description: 'Facet labels: ''hidden'' or styling overrides.' title: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: text: type: string description: Trellis title text. fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Title color: hex or `{ kind: theme, ref }`.' description: 'Facet title: ''hidden'', or text and styling overrides.' description: Format for the trellis column facet. row: type: object properties: border: type: string enum: - hidden description: Set to 'hidden' to hide the row/column border. labels: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Label color: hex or `{ kind: theme, ref }`.' description: 'Facet labels: ''hidden'' or styling overrides.' title: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: text: type: string description: Trellis title text. fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Title color: hex or `{ kind: theme, ref }`.' description: 'Facet title: ''hidden'', or text and styling overrides.' description: Format for the trellis row facet. rowsBy: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID placed on this shelf position. - type: object properties: sort: oneOf: - allOf: - type: object required: - type - columnId - direction properties: type: type: string enum: - column description: Sort by another column. columnId: type: string description: Column ID to sort by. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation when sorting by another column. - type: object required: - type - direction properties: type: type: string enum: - row-count description: Sort by row count. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: type: type: string enum: - values description: Sort by this column's own values (default when `type` is omitted). description: 'Custom sort: direction plus optional `type` (`values`, `column`, or `row-count`).' description: Dimension column on the trellis row shelf (category mode). At most one entry; uses pivot shelf array shape. series: oneOf: - type: string enum: - row - type: string enum: - column description: Trellis by series direction. Mutually exclusive with `rowsBy` / `columnsBy`. share: type: object properties: color-legends: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share color legends across the trellis grid. Omit when 'shared' (default). size-legends: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share size legends across panels. Omit when 'shared'. Scatter with a size channel only. x-axis: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the category-axis scale across panels (UI label follows chart orientation). y-axis: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the series-axis scale across panels (UI label follows chart orientation). y-axis-2: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the second series-axis scale. Combo charts with a second value axis only. description: Shared scales and legends across trellis panels. tileSize: oneOf: - type: string enum: - auto - type: string enum: - compact description: Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series. description: Trellis bindings (rowsBy, columnsBy, series), tile size, facet styling, and shared scales/legends. trendlines: type: array items: allOf: - type: object required: - columnId - model properties: columnId: type: string description: Series column id (Y-axis) to fit the trend line to. model: oneOf: - type: string enum: - linear - type: string enum: - quadratic - type: string enum: - polynomial - type: string enum: - exponential - type: string enum: - logarithmic - type: string enum: - power description: 'Regression model matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power.' - type: object properties: degree: type: number description: Polynomial degree (3–7). Required when model is 'polynomial'. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Trend line stroke styling. label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `value` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. value: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `value` block entirely to hide it. description: Regression fit value (R²). Omit the block to hide the value. caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and value annotations. description: Regression trend lines on the chart. - type: object properties: actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. description: '' title: Scatter Chart - allOf: - type: object required: - id - kind - source - columns - yAxis properties: id: type: string description: The identifier of the combo chart. kind: type: string enum: - combo-chart source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the combo chart. columns: type: array items: allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. description: The columns used by the combo chart. yAxis: allOf: - type: object required: - columnIds properties: columnIds: type: array items: oneOf: - type: string description: Column ID for a Y-axis series. - allOf: - type: object required: - columnId properties: columnId: type: string description: Column ID for a Y-axis series. - type: object properties: type: oneOf: - type: string enum: - bar - type: string enum: - line - type: string enum: - area - type: string enum: - scatter description: 'Per-series chart shape: ''bar'' (default), ''line'', ''area'', or ''scatter''.' description: Column IDs for the Y-axis series. - type: object properties: format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: Y-axis title, labels, marks, and scale formatting. description: The columns used for the Y-axis. Each entry can specify its own `type` (bar / line / area / scatter); default is bar. - type: object properties: yAxis2: allOf: - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column ID for a series assigned to Y-axis 2. description: Column IDs for series on the secondary Y-axis. - type: object properties: format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: Y-axis 2 title, labels, marks, scale, and tick spacing. description: 'Secondary Y-axis: series assignment (`columnIds`) and axis formatting (`format`). Combo only.' xAxis: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID for the X-axis. - type: object properties: sort: allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: by: type: string description: Column ID to sort by, or "row-count" to sort by number of rows. If omitted, sorts by the column values themselves. aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation function for custom sort. Only valid when "by" references a column ID (not "row-count"). description: Sort order. format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: X-axis title, labels, marks, and scale formatting. description: The column used for the X-axis. name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. align: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Title alignment: ''start'', ''middle'', or ''end''.' description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Chart description (subtitle / tooltip text) plus optional styling. noDataText: type: string description: Custom message rendered when the chart has no data. legend: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the legend. No other fields on this branch. - type: object properties: position: oneOf: - type: string enum: - auto - type: string enum: - top - type: string enum: - right - type: string enum: - bottom - type: string enum: - left - type: string enum: - top-left - type: string enum: - top-right - type: string enum: - bottom-left - type: string enum: - bottom-right description: Legend position. Default 'auto'. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Legend label font size in pixels. colorLegend: type: string enum: - hidden description: Hide the color legend when both color and size legends apply. sizeLegend: type: string enum: - hidden description: Hide the size legend when a size channel is present. header: type: string enum: - hidden description: Hide the legend header row. description: Legend visibility, position, and label styling. tooltip: type: object properties: columnNames: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether column names appear in the tooltip. multiSeries: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the tooltip lists multiple series. Only supported on bar, line, and area charts. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Tooltip value format. Omit when the chart default applies. description: 'Tooltip display options: column names, multiple series, and percent formatting.' stacking: oneOf: - type: string enum: - none - type: string enum: - stacked - type: string enum: - normalized description: 'Stacking mode: ''none'' (side-by-side / overlapping), ''stacked'' (default — values sum), or ''normalized'' (stack scaled to 100%).' color: oneOf: - type: object required: - by - value properties: by: type: string enum: - single value: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' - allOf: - type: object required: - by - column properties: by: type: string enum: - category column: type: string description: Column id whose values drive the categorical color assignment. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. - allOf: - type: object required: - by - column properties: by: type: string enum: - scale column: type: string description: Numeric column id whose values drive the continuous color gradient. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. domain: type: object properties: min: type: number description: Continuous-scale domain minimum. max: type: number description: Continuous-scale domain maximum. mid: type: number description: Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential. description: 'Color configuration: single hex, categorical column, or continuous gradient.' barStyle: type: object properties: cornerRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Bar corner shape: ''square'' (default), ''round'', or ''pill''.' description: 'Bar corner shape for bar layers: ''square'' (default), ''round'', or ''pill''.' dataLabel: type: object properties: anchor: oneOf: - type: string enum: - auto - type: string enum: - end - type: string enum: - middle - type: string enum: - outside-end - type: string enum: - start description: Position of the data label relative to its mark. clearance: oneOf: - type: string enum: - separated - type: string enum: - default description: Spacing between data labels and neighboring marks when labels could overlap lines or areas. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color used for data label text (hex or theme reference). fontSize: type: number description: Font size for data labels, in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Data-label font weight: ''normal'' or ''bold''.' labelDisplay: oneOf: - type: string enum: - all - type: string enum: - all-points - type: string enum: - auto - type: string enum: - color - type: string enum: - color-percent - type: string enum: - color-value - type: string enum: - endpoints - type: string enum: - maximum - type: string enum: - min-max - type: string enum: - minimum - type: string enum: - most-recent - type: string enum: - percent - type: string enum: - value - type: string enum: - value-percent description: Which values and labels to show on data labels when applying defaults for all series. labels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. orient: oneOf: - type: string enum: - auto - type: string enum: - horizontal - type: string enum: - vertical description: Text direction for data labels. precision: type: number description: Number of decimal places when labels include percentages. showStroke: oneOf: - type: string enum: - auto - type: string enum: - 'on' - type: string enum: - 'off' description: Outline around data labels. totals: type: object properties: display: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. fontSize: type: number description: Font size for total labels, in pixels. labelDisplay: oneOf: - type: string enum: - auto - type: string enum: - minimum - type: string enum: - maximum - type: string enum: - min-max - type: string enum: - all description: Which values and labels to show on total (aggregate) labels. orient: oneOf: - type: string enum: - horizontal - type: string enum: - vertical description: Text direction for total labels. description: Options for aggregate total labels when the combo includes bar layers. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Whether numeric values are shown as percentages or as plain numbers. description: Default data label settings for the combo chart. Layer-specific settings may override these. gap: type: object properties: width: oneOf: - type: string enum: - auto - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Gap width between individual bars in a band (format panel: Gap width).' betweenSets: oneOf: - type: string enum: - auto - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Gap between bar clusters when the chart is clustered (format panel: Gap between sets).' description: Bar gap width and spacing between clustered bar sets on combo bar layers. filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this chart. seriesDataLabel: type: object properties: area: type: object properties: clearance: oneOf: - type: string enum: - separated - type: string enum: - default description: Spacing between data labels and neighboring marks when labels could overlap lines or areas. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color used for data label text (hex or theme reference). fontSize: type: number description: Font size for data labels, in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Data-label font weight: ''normal'' or ''bold''.' labelDisplay: oneOf: - type: string enum: - auto - type: string enum: - minimum - type: string enum: - maximum - type: string enum: - min-max - type: string enum: - endpoints - type: string enum: - most-recent - type: string enum: - all-points description: Which values and labels to show on area layer labels. labels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. showStroke: oneOf: - type: string enum: - auto - type: string enum: - 'on' - type: string enum: - 'off' description: Outline around data labels. bar: type: object properties: anchor: oneOf: - type: string enum: - auto - type: string enum: - end - type: string enum: - middle - type: string enum: - outside-end - type: string enum: - start description: Position of the data label relative to its mark. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color used for data label text (hex or theme reference). fontSize: type: number description: Font size for data labels, in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Data-label font weight: ''normal'' or ''bold''.' labelDisplay: oneOf: - type: string enum: - auto - type: string enum: - minimum - type: string enum: - maximum - type: string enum: - min-max - type: string enum: - all description: Which values and labels to show on each bar segment label. labels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. orient: oneOf: - type: string enum: - auto - type: string enum: - horizontal - type: string enum: - vertical description: Text direction for data labels. precision: type: number description: Number of decimal places when labels include percentages. showStroke: oneOf: - type: string enum: - auto - type: string enum: - 'on' - type: string enum: - 'off' description: Outline around data labels. totals: type: object properties: display: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. fontSize: type: number description: Font size for total labels, in pixels. labelDisplay: oneOf: - type: string enum: - auto - type: string enum: - minimum - type: string enum: - maximum - type: string enum: - min-max - type: string enum: - all description: Which values and labels to show on total (aggregate) labels. orient: oneOf: - type: string enum: - horizontal - type: string enum: - vertical description: Text direction for total labels. description: Options for aggregate total labels on bar charts. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Whether numeric values are shown as percentages or as plain numbers. line: type: object properties: clearance: oneOf: - type: string enum: - separated - type: string enum: - default description: Spacing between data labels and neighboring marks when labels could overlap lines or areas. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color used for data label text (hex or theme reference). fontSize: type: number description: Font size for data labels, in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Data-label font weight: ''normal'' or ''bold''.' labelDisplay: oneOf: - type: string enum: - auto - type: string enum: - minimum - type: string enum: - maximum - type: string enum: - min-max - type: string enum: - endpoints - type: string enum: - most-recent - type: string enum: - all-points description: Which values and labels to show on line layer labels. labels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. showStroke: oneOf: - type: string enum: - auto - type: string enum: - 'on' - type: string enum: - 'off' description: Outline around data labels. scatter: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color used for data label text (hex or theme reference). fontSize: type: number description: Font size for data labels, in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Data-label font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. precision: type: number description: Number of decimal places when labels use percent format. showStroke: oneOf: - type: string enum: - auto - type: string enum: - 'on' - type: string enum: - 'off' description: Outline around data labels. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Whether numeric values are shown as percentages or as plain numbers. description: 'Data label settings grouped by layer: bar, line, area, or scatter.' pointStyle: type: object properties: shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. - oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: Point size preset when a size channel is bound. Maps to store area values (Small/Medium/Large in the format panel). description: Default point marker shape and size for scatter layers. seriesPointStyle: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: Y-axis column id for a combo scatter layer. - type: object properties: shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. - oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: Point size preset when a size channel is bound. Maps to store area values (Small/Medium/Large in the format panel). description: Per-series point style overrides on combo charts (scatter layers only). Each entry lists only fields that differ from `pointStyle`. backgroundImage: type: object required: - url properties: url: type: string description: The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported). description: Optional plot-area background image. Url supports dynamic-text {{formula}} references. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' lineAreaStyle: type: object properties: interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Area outline visibility. Omit when shown; only 'hidden' is emitted on read. Not valid on line-chart. style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke and (on area charts) area outline visibility. points: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Point markers. Omit when shown; only 'hidden' is emitted on read. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on the series. description: Default line/area layer interpolation, stroke, points, and null handling. seriesLineAreaStyle: type: object additionalProperties: type: object properties: interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Area outline visibility. Omit when shown; only 'hidden' is emitted on read. Not valid on line-chart. style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke and (on area charts) area outline visibility. points: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Point markers. Omit when shown; only 'hidden' is emitted on read. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on the series. description: Per-series line/area style overrides on combo charts (Y-axis column id keys). refMarks: type: array items: oneOf: - allOf: - type: object required: - type - axis - value properties: type: type: string enum: - line description: Reference line. axis: oneOf: - type: string enum: - axis - type: string enum: - series - type: string enum: - series2 description: 'Axis channel: primary axis (''axis''), primary series (''series''), or secondary series (''series2'').' value: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Position on the axis (constant, column aggregation, or formula). - type: object properties: line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Line color (hex or theme reference). description: Line stroke styling. - type: object properties: label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. annotation: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. description: Computed value label. Omit the block to hide the value (not the mark `value` field). caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and computed-value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and annotation. scope: oneOf: - type: string enum: - chart - type: string enum: - cell description: 'Trellis scope: ''chart'' (shared) or ''cell'' (per panel). Omit for the default shared scope.' - allOf: - type: object required: - type - axis - value - endValue properties: type: type: string enum: - band description: Reference band. axis: oneOf: - type: string enum: - axis - type: string enum: - series - type: string enum: - series2 description: 'Axis channel: primary axis (''axis''), primary series (''series''), or secondary series (''series2'').' value: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Band start position (constant, column aggregation, or formula). endValue: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Band end position (constant, column aggregation, or formula). - type: object properties: line: type: object properties: visibility: type: string enum: - shown description: Band outline visibility. Set to 'shown' to draw the band border. style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Line color (hex or theme reference). description: Band outline stroke styling. fill: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Band fill color (hex or theme reference). description: Band fill color. - type: object properties: label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. annotation: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. description: Computed value label. Omit the block to hide the value (not the mark `value` field). caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and computed-value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and annotation. scope: oneOf: - type: string enum: - chart - type: string enum: - cell description: 'Trellis scope: ''chart'' (shared) or ''cell'' (per panel). Omit for the default shared scope.' description: Reference lines and bands on the chart. trellis: type: object properties: columnsBy: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID placed on this shelf position. - type: object properties: sort: oneOf: - allOf: - type: object required: - type - columnId - direction properties: type: type: string enum: - column description: Sort by another column. columnId: type: string description: Column ID to sort by. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation when sorting by another column. - type: object required: - type - direction properties: type: type: string enum: - row-count description: Sort by row count. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: type: type: string enum: - values description: Sort by this column's own values (default when `type` is omitted). description: 'Custom sort: direction plus optional `type` (`values`, `column`, or `row-count`).' description: Dimension column on the trellis column shelf (category mode). At most one entry; uses pivot shelf array shape. column: type: object properties: border: type: string enum: - hidden description: Set to 'hidden' to hide the row/column border. labels: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Label color: hex or `{ kind: theme, ref }`.' description: 'Facet labels: ''hidden'' or styling overrides.' title: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: text: type: string description: Trellis title text. fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Title color: hex or `{ kind: theme, ref }`.' description: 'Facet title: ''hidden'', or text and styling overrides.' description: Format for the trellis column facet. row: type: object properties: border: type: string enum: - hidden description: Set to 'hidden' to hide the row/column border. labels: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Label color: hex or `{ kind: theme, ref }`.' description: 'Facet labels: ''hidden'' or styling overrides.' title: oneOf: - type: string enum: - hidden description: Hide this guide component. - type: object properties: text: type: string description: Trellis title text. fontSize: type: number description: Font size in pixels. color: oneOf: - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string - type: string description: 'Title color: hex or `{ kind: theme, ref }`.' description: 'Facet title: ''hidden'', or text and styling overrides.' description: Format for the trellis row facet. rowsBy: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID placed on this shelf position. - type: object properties: sort: oneOf: - allOf: - type: object required: - type - columnId - direction properties: type: type: string enum: - column description: Sort by another column. columnId: type: string description: Column ID to sort by. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation when sorting by another column. - type: object required: - type - direction properties: type: type: string enum: - row-count description: Sort by row count. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: type: type: string enum: - values description: Sort by this column's own values (default when `type` is omitted). description: 'Custom sort: direction plus optional `type` (`values`, `column`, or `row-count`).' description: Dimension column on the trellis row shelf (category mode). At most one entry; uses pivot shelf array shape. series: oneOf: - type: string enum: - row - type: string enum: - column description: Trellis by series direction. Mutually exclusive with `rowsBy` / `columnsBy`. share: type: object properties: color-legends: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share color legends across the trellis grid. Omit when 'shared' (default). size-legends: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share size legends across panels. Omit when 'shared'. Scatter with a size channel only. x-axis: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the category-axis scale across panels (UI label follows chart orientation). y-axis: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the series-axis scale across panels (UI label follows chart orientation). y-axis-2: oneOf: - type: string enum: - shared - type: string enum: - separate description: Share the second series-axis scale. Combo charts with a second value axis only. description: Shared scales and legends across trellis panels. tileSize: oneOf: - type: string enum: - auto - type: string enum: - compact description: Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series. description: Trellis bindings (rowsBy, columnsBy, series), tile size, facet styling, and shared scales/legends. trendlines: type: array items: allOf: - type: object required: - columnId - model properties: columnId: type: string description: Series column id (Y-axis) to fit the trend line to. model: oneOf: - type: string enum: - linear - type: string enum: - quadratic - type: string enum: - polynomial - type: string enum: - exponential - type: string enum: - logarithmic - type: string enum: - power description: 'Regression model matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power.' - type: object properties: degree: type: number description: Polynomial degree (3–7). Required when model is 'polynomial'. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Trend line stroke styling. label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `value` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. value: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `value` block entirely to hide it. description: Regression fit value (R²). Omit the block to hide the value. caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and value annotations. description: Regression trend lines on the chart. - type: object properties: actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. description: '' title: Combo Chart - allOf: - type: object required: - id - kind - source - columns - yAxis properties: id: type: string description: The identifier of the waterfall chart. kind: type: string enum: - waterfall-chart source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the waterfall chart. columns: type: array items: allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. description: The columns used by the waterfall chart. yAxis: allOf: - type: object required: - columnIds properties: columnIds: type: array items: oneOf: - type: string description: Column ID for a Y-axis series. - allOf: - type: object required: - columnId properties: columnId: type: string description: Column ID for a Y-axis series. - type: object properties: type: oneOf: - type: string enum: - bar - type: string enum: - line - type: string enum: - area - type: string enum: - scatter description: 'Per-series chart shape: ''bar'' (default), ''line'', ''area'', or ''scatter''.' description: Column IDs for the Y-axis series. - type: object properties: format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: Y-axis title, labels, marks, and scale formatting. description: The columns used for the Y-axis. - type: object properties: xAxis: allOf: - type: object required: - columnId properties: columnId: type: string description: The column ID for the X-axis. - type: object properties: sort: allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: by: type: string description: Column ID to sort by, or "row-count" to sort by number of rows. If omitted, sorts by the column values themselves. aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation function for custom sort. Only valid when "by" references a column ID (not "row-count"). description: Sort order. format: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the axis. No other fields on this branch. - type: object properties: title: type: object properties: text: type: string description: Axis title text. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' labels: oneOf: - type: string enum: - hidden - type: object properties: labelAngle: oneOf: - type: number - type: string enum: - auto description: Label angle in degrees, or 'auto'. fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to let the viz pick. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' allowLongerLabels: type: boolean description: Allow longer axis labels without truncation. marks: oneOf: - type: string enum: - none - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Axis marks: ''none'', ''tick'', ''grid'', or ''both''.' scale: type: object properties: type: oneOf: - type: string enum: - linear - type: string enum: - log - type: string enum: - ordinal - type: string enum: - pow - type: string enum: - sqrt - type: string enum: - time description: Axis scale type. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. zero: type: boolean description: Always include zero in the axis domain. reverse: type: boolean description: Reverse the axis direction. hideZeroLine: type: boolean description: Hide the zero guideline on the axis. tickSpacing: oneOf: - type: object required: - type properties: type: type: string enum: - auto description: Automatic axis mark spacing. - type: object required: - type - count properties: type: type: string enum: - count description: Target tick count spacing. count: type: number description: Approximate number of axis marks (1–30 in the UI). - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: type: string enum: - auto description: Let the viz pick the time interval unit. - allOf: - type: object required: - type - scale - unit properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - time description: Interval mode for a time scale. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Time interval unit. - type: object properties: step: type: number description: Number of units between each axis mark. anchor: oneOf: - type: number - type: 'null' description: Epoch milliseconds anchor, or null. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - unit - step - mark properties: unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week - type: string enum: - day - type: string enum: - hour - type: string enum: - minute - type: string enum: - second description: Minor tick time unit. step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: string enum: - auto description: Let the viz pick the numeric step. - allOf: - type: object required: - type - scale - step properties: type: type: string enum: - interval description: Fixed interval spacing. scale: type: string enum: - linear description: Interval mode for a linear scale. step: type: number description: Step in axis data units (same units as the linear scale domain). - type: object properties: anchor: type: number description: Numeric anchor for tick alignment. minor: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Hide minor axis marks. No other fields on this branch. - type: object required: - step - mark properties: step: type: number description: Minor tick step size. mark: oneOf: - type: string enum: - tick - type: string enum: - grid - type: string enum: - both description: 'Minor axis mark style: ''tick'', ''grid'', or ''both''.' description: X-axis title, labels, marks, and scale formatting. description: The column used for the X-axis. name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. align: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Title alignment: ''start'', ''middle'', or ''end''.' description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Chart description (subtitle / tooltip text) plus optional styling. noDataText: type: string description: Custom message rendered when the chart has no data. legend: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the legend. No other fields on this branch. - type: object properties: position: oneOf: - type: string enum: - auto - type: string enum: - top - type: string enum: - right - type: string enum: - bottom - type: string enum: - left - type: string enum: - top-left - type: string enum: - top-right - type: string enum: - bottom-left - type: string enum: - bottom-right description: Legend position. Default 'auto'. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Legend label font size in pixels. colorLegend: type: string enum: - hidden description: Hide the color legend when both color and size legends apply. sizeLegend: type: string enum: - hidden description: Hide the size legend when a size channel is present. header: type: string enum: - hidden description: Hide the legend header row. description: Legend visibility, position, and label styling. tooltip: type: object properties: columnNames: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether column names appear in the tooltip. multiSeries: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the tooltip lists multiple series. Only supported on bar, line, and area charts. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Tooltip value format. Omit when the chart default applies. description: 'Tooltip display options: column names and value formatting.' grouping: oneOf: - type: string enum: - stacked - type: string enum: - clustered description: 'Series grouping: ''stacked'' (default) or ''clustered'' (no stacking).' splitBy: type: object required: - id properties: id: type: string description: The column ID. description: Optional column that splits the waterfall into series. color: oneOf: - type: object required: - by - value properties: by: type: string enum: - single value: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' - allOf: - type: object required: - by - column properties: by: type: string enum: - category column: type: string description: Column id whose values drive the categorical color assignment. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. - allOf: - type: object required: - by - column properties: by: type: string enum: - scale column: type: string description: Numeric column id whose values drive the continuous color gradient. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. domain: type: object properties: min: type: number description: Continuous-scale domain minimum. max: type: number description: Continuous-scale domain maximum. mid: type: number description: Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential. description: 'Color configuration: single hex, categorical column, or continuous gradient.' waterfallColors: type: object properties: decrease: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color for decreasing waterfall bars. increase: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color for increasing waterfall bars. total: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color for subtotal and end total bars. description: Increase, decrease, and total bar colors. waterfallShape: type: object properties: calculation: oneOf: - type: string enum: - sum - type: string enum: - difference description: 'How bar values combine: ''sum'' (default) or ''difference''.' connectorLine: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether connector lines between bars are shown. connectorLineColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Connector line color. endTotal: type: object properties: label: type: string description: Custom label text. visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the label is shown. Omit when default applies. description: End total bar label options. subtotal: type: object properties: label: type: string description: Custom label text. visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the label is shown. Omit when default applies. description: Subtotal bar label options. description: Calculation mode, connector lines, subtotal/end labels. startPoint: type: object properties: label: type: string description: Start bar label text. value: oneOf: - type: object required: - type properties: type: type: string enum: - first-value - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: oneOf: - type: number - type: 'null' description: Constant start value. Null clears the numeric value. - type: object required: - columnId - func - type properties: columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation for a column-based start value. type: type: string enum: - column description: How the start value is computed. visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Start bar visibility. Set to 'hidden' for None. description: Starting bar value and label. dataLabel: type: object properties: anchor: oneOf: - type: string enum: - auto - type: string enum: - end - type: string enum: - middle - type: string enum: - outside-end - type: string enum: - start description: Position of the data label relative to its mark. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color used for data label text (hex or theme reference). fontSize: type: number description: Font size for data labels, in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Data-label font weight: ''normal'' or ''bold''.' labelDisplay: oneOf: - type: string enum: - auto - type: string enum: - minimum - type: string enum: - maximum - type: string enum: - min-max - type: string enum: - all description: Which values and labels to show on each bar segment label. labels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether values appear on chart marks. precision: type: number description: Number of decimal places when labels include percentages. valueFormat: oneOf: - type: string enum: - percent - type: string enum: - number description: Whether numeric values are shown as percentages or as plain numbers. description: Data label typography, placement, and display options. filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this chart. backgroundImage: type: object required: - url properties: url: type: string description: The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported). description: Optional plot-area background image. Url supports dynamic-text {{formula}} references. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' refMarks: type: array items: oneOf: - allOf: - type: object required: - type - axis - value properties: type: type: string enum: - line description: Reference line. axis: oneOf: - type: string enum: - axis - type: string enum: - series - type: string enum: - series2 description: 'Axis channel: primary axis (''axis''), primary series (''series''), or secondary series (''series2'').' value: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Position on the axis (constant, column aggregation, or formula). - type: object properties: line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Line color (hex or theme reference). description: Line stroke styling. - type: object properties: label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. annotation: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. description: Computed value label. Omit the block to hide the value (not the mark `value` field). caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and computed-value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and annotation. scope: oneOf: - type: string enum: - chart - type: string enum: - cell description: 'Trellis scope: ''chart'' (shared) or ''cell'' (per panel). Omit for the default shared scope.' - allOf: - type: object required: - type - axis - value - endValue properties: type: type: string enum: - band description: Reference band. axis: oneOf: - type: string enum: - axis - type: string enum: - series - type: string enum: - series2 description: 'Axis channel: primary axis (''axis''), primary series (''series''), or secondary series (''series2'').' value: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Band start position (constant, column aggregation, or formula). endValue: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - constant - type: object properties: value: type: number description: Constant position on the axis. Omit when unset. - type: object required: - type - columnId - func properties: type: type: string enum: - column columnId: type: string description: Column id for the aggregation. func: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - min - type: string enum: - max - type: string enum: - median description: Aggregation for a column-based mark value. - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Sling formula returning a number or datetime for the mark position. description: Band end position (constant, column aggregation, or formula). - type: object properties: line: type: object properties: visibility: type: string enum: - shown description: Band outline visibility. Set to 'shown' to draw the band border. style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Line type: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Line width in pixels (1–5). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Line color (hex or theme reference). description: Band outline stroke styling. fill: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Band fill color (hex or theme reference). description: Band fill color. - type: object properties: label: allOf: - type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. - type: object properties: text: type: string description: Custom label text. description: Custom label. Omit the block to hide the label. annotation: type: object required: - visibility properties: visibility: type: string enum: - shown description: Annotation is shown. Omit the `label` or `annotation` block entirely to hide it. description: Computed value label. Omit the block to hide the value (not the mark `value` field). caption: type: object properties: position: oneOf: - type: string enum: - top-right - type: string enum: - top-center - type: string enum: - top-left - type: string enum: - bottom-right - type: string enum: - bottom-center - type: string enum: - bottom-left - type: string enum: - middle-right - type: string enum: - middle-left description: Label and computed-value annotation position. fontSize: type: number description: Annotation font size in pixels (same control as in the format panel). color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' description: Shared placement and typography for label and annotation. scope: oneOf: - type: string enum: - chart - type: string enum: - cell description: 'Trellis scope: ''chart'' (shared) or ''cell'' (per panel). Omit for the default shared scope.' description: Reference lines and bands on the chart. description: '' title: Waterfall Chart - allOf: - type: object required: - id - kind - source - columns - latitude - longitude properties: id: type: string description: The identifier of the point map. kind: type: string enum: - point-map source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the point map. columns: type: array items: allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. description: The columns used by the point map. latitude: type: object required: - id properties: id: type: string description: The column ID. description: The column whose values are point latitudes (degrees, WGS84). longitude: type: object required: - id properties: id: type: string description: The column ID. description: The column whose values are point longitudes (degrees, WGS84). - type: object properties: name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`. Maps do not support alignment.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Map description (subtitle / tooltip text) plus optional styling. legend: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the legend. No other fields on this branch. - type: object properties: position: oneOf: - type: string enum: - top-left - type: string enum: - top-right - type: string enum: - bottom-left - type: string enum: - bottom-right description: Legend corner position on maps. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Legend label font size in pixels. header: type: string enum: - hidden description: Hide the legend header row. description: Legend visibility, corner position, and label styling. mapStyle: oneOf: - oneOf: - type: object - allOf: - type: object properties: accessToken: type: string description: 'Mapbox access token. Write-only: never returned on read.' allowZoom: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Allow pan and zoom on the map. Omit when shown (default). - type: object required: - baseStyle - styleUrl properties: baseStyle: type: string enum: - custom description: Custom Mapbox style; requires `styleUrl`. styleUrl: type: string description: Mapbox style URL. Required when `baseStyle` is `custom`. - type: object - oneOf: - type: object - type: object - type: object - type: 'null' description: 'Map style: base style, custom URL, allow pan/zoom, and write-only Mapbox access token.' pointStyle: oneOf: - type: object properties: opacity: type: number description: Mark opacity from 0 to 1. Omit when fully opaque (1). pointSize: oneOf: - type: number description: Point diameter in pixels (1–40). Omit when default (5). - type: array minItems: 2 maxItems: 2 items: type: number description: Min and max point diameters in pixels when a size channel is bound. Omit when default [3, 15]. - type: 'null' description: Point mark opacity and size for the format-panel Point style section. size: type: object required: - id properties: id: type: string description: The column ID. description: Optional column whose values drive the bubble size. color: oneOf: - type: object required: - by - value properties: by: type: string enum: - single value: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' - allOf: - type: object required: - by - column properties: by: type: string enum: - category column: type: string description: Column id whose values drive the categorical color assignment. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. - allOf: - type: object required: - by - column properties: by: type: string enum: - scale column: type: string description: Numeric column id whose values drive the continuous color gradient. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. domain: type: object properties: min: type: number description: Continuous-scale domain minimum. max: type: number description: Continuous-scale domain maximum. mid: type: number description: Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential. description: 'Color configuration: single hex, categorical column, or continuous gradient.' label: type: array items: type: object required: - id properties: id: type: string description: The column ID. description: Optional columns rendered as text labels next to each point. tooltip: type: array items: type: object required: - id properties: id: type: string description: The column ID. description: Optional columns shown in the hover tooltip. tooltipFormat: type: object properties: columnNames: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether column names appear in the tooltip. description: Tooltip display options. Maps use `tooltip` for hover column refs; use `tooltipFormat` for format-panel settings. filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this chart. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object properties: actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. description: '' title: Point Map - allOf: - type: object required: - id - kind - source - columns - region properties: id: type: string description: The identifier of the region map. kind: type: string enum: - region-map source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the region map. columns: type: array items: allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. description: The columns used by the region map. region: allOf: - type: object required: - id properties: id: type: string description: The column ID. - type: object required: - regionType properties: regionType: oneOf: - type: string enum: - country - type: string enum: - us-state - type: string enum: - us-county - type: string enum: - us-zipcode - type: string enum: - us-cbsa - type: string enum: - us-postal-place - type: string enum: - ca-province description: Which kind of region the column represents (country, us-state, etc.). Sets the column's geo-region semantic role. description: The region column and the kind of region it contains. - type: object properties: name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`. Maps do not support alignment.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Map description (subtitle / tooltip text) plus optional styling. legend: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the legend. No other fields on this branch. - type: object properties: position: oneOf: - type: string enum: - top-left - type: string enum: - top-right - type: string enum: - bottom-left - type: string enum: - bottom-right description: Legend corner position on maps. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Legend label font size in pixels. header: type: string enum: - hidden description: Hide the legend header row. description: Legend visibility, corner position, and label styling. mapStyle: oneOf: - oneOf: - type: object - allOf: - type: object properties: accessToken: type: string description: 'Mapbox access token. Write-only: never returned on read.' allowZoom: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Allow pan and zoom on the map. Omit when shown (default). - type: object required: - baseStyle - styleUrl properties: baseStyle: type: string enum: - custom description: Custom Mapbox style; requires `styleUrl`. styleUrl: type: string description: Mapbox style URL. Required when `baseStyle` is `custom`. - type: object - oneOf: - type: object - type: object - type: object - type: 'null' description: 'Map style: base style, custom URL, allow pan/zoom, and write-only Mapbox access token.' regionStyle: oneOf: - type: object properties: opacity: type: number description: Mark opacity from 0 to 1. Omit when fully opaque (1). - type: 'null' description: Region fill opacity for the format-panel Region style section. color: oneOf: - type: object required: - by - value properties: by: type: string enum: - single value: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' - allOf: - type: object required: - by - column properties: by: type: string enum: - category column: type: string description: Column id whose values drive the categorical color assignment. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. - allOf: - type: object required: - by - column properties: by: type: string enum: - scale column: type: string description: Numeric column id whose values drive the continuous color gradient. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. domain: type: object properties: min: type: number description: Continuous-scale domain minimum. max: type: number description: Continuous-scale domain maximum. mid: type: number description: Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential. description: 'Color configuration: single hex, categorical column, or continuous gradient.' label: type: array items: type: object required: - id properties: id: type: string description: The column ID. description: Optional columns rendered as text labels on each region. tooltip: type: array items: type: object required: - id properties: id: type: string description: The column ID. description: Optional columns shown in the hover tooltip. tooltipFormat: type: object properties: columnNames: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether column names appear in the tooltip. description: Tooltip display options. Maps use `tooltip` for hover column refs; use `tooltipFormat` for format-panel settings. filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this chart. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object properties: actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. description: '' title: Region Map - allOf: - type: object required: - id - kind - source - columns - geography properties: id: type: string description: The identifier of the geography map. kind: type: string enum: - geography-map source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the geography map. columns: type: array items: allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. description: The columns used by the geography map. geography: type: object required: - id properties: id: type: string description: The column ID. description: The column whose values are GeoJSON geometries (Point, Polygon, MultiPolygon, LineString, etc.). - type: object properties: name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`. Maps do not support alignment.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Map description (subtitle / tooltip text) plus optional styling. legend: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to hide the legend. No other fields on this branch. - type: object properties: position: oneOf: - type: string enum: - top-left - type: string enum: - top-right - type: string enum: - bottom-left - type: string enum: - bottom-right description: Legend corner position on maps. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Legend label font size in pixels. header: type: string enum: - hidden description: Hide the legend header row. description: Legend visibility, corner position, and label styling. mapStyle: oneOf: - oneOf: - type: object - allOf: - type: object properties: accessToken: type: string description: 'Mapbox access token. Write-only: never returned on read.' allowZoom: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Allow pan and zoom on the map. Omit when shown (default). - type: object required: - baseStyle - styleUrl properties: baseStyle: type: string enum: - custom description: Custom Mapbox style; requires `styleUrl`. styleUrl: type: string description: Mapbox style URL. Required when `baseStyle` is `custom`. - type: object - oneOf: - type: object - type: object - type: object - type: 'null' description: 'Map style: base style, custom URL, allow pan/zoom, and write-only Mapbox access token.' featureStyle: oneOf: - type: object properties: opacity: type: number description: Mark opacity from 0 to 1. Omit when fully opaque (1). pointSize: type: number description: Point diameter in pixels (1–40). Omit when default (5). - type: 'null' description: Feature mark opacity and point size for the format-panel Feature style section. color: oneOf: - type: object required: - by - value properties: by: type: string enum: - single value: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' - allOf: - type: object required: - by - column properties: by: type: string enum: - category column: type: string description: Column id whose values drive the categorical color assignment. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. - allOf: - type: object required: - by - column properties: by: type: string enum: - scale column: type: string description: Numeric column id whose values drive the continuous color gradient. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops defining the palette / gradient. domain: type: object properties: min: type: number description: Continuous-scale domain minimum. max: type: number description: Continuous-scale domain maximum. mid: type: number description: Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential. description: 'Color configuration: single hex, categorical column, or continuous gradient.' tooltip: type: array items: type: object required: - id properties: id: type: string description: The column ID. description: Optional columns shown in the hover tooltip. tooltipFormat: type: object properties: columnNames: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether column names appear in the tooltip. description: Tooltip display options. Maps use `tooltip` for hover column refs; use `tooltipFormat` for format-panel settings. filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this chart. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object properties: actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. description: '' title: Geography Map - allOf: - type: object required: - id - kind - source - columns - values properties: id: type: string description: The identifier of the pivot table. kind: type: string enum: - pivot-table source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - connectionId - kind - inodeId properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - csv-table inodeId: type: string description: The identifier of the CSV-backed table in Sigma. description: '' title: CSV Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - metric-view description: A Databricks metric view, referenced by connection and warehouse path. title: Metric View - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - semantic-view description: A Snowflake semantic view, referenced by connection and warehouse path, where the final path segment is the base logical table. title: Semantic View - type: object required: - connectionId - kind - statement properties: connectionId: type: string description: The identifier of the connection to the data platform. kind: type: string enum: - sql statement: type: string description: The custom SQL statement used in the element. description: '' title: Custom SQL - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model - allOf: - type: object required: - kind - joins properties: kind: type: string enum: - join joins: type: array items: allOf: - type: object required: - left - right - columns properties: left: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the left table in the join. right: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The name of the right table in the join. columns: type: array items: allOf: - type: object required: - left - right properties: left: type: string description: The column reference or formula expression from the left source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. right: type: string description: The column reference or formula expression from the right source used in the join. E.g. ”[ID]” or ”DateTrunc(`year`, [Date])”. - type: object properties: op: oneOf: - type: string enum: - < - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>=' - type: string enum: - '>' - type: string enum: - within - type: string enum: - intersects - type: string enum: - is-distinct-from - type: string enum: - is-not-distinct-from description: The comparison operator used in the join. Defaults to =. within and intersects are only supported with the Geography data type. description: A list of the column pairs and operators that define this join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the right. joinType: oneOf: - type: string enum: - inner - type: string enum: - left-outer - type: string enum: - right-outer - type: string enum: - full-outer - type: string enum: - lookup description: The logical join type. description: A list of the joins and their definitions. The left of each join must be either the primary source or the right of some other join. - type: object properties: name: type: string description: The name of the join. Defaults to the name of the primary source. primarySource: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The primary/head source of the join. If not specified, it is inferred as the unique source that appears on the left of some join but never on the right. description: '' title: Join - type: object required: - kind - sources - matches properties: kind: type: string enum: - union sources: type: array items: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifiers of the sources in the union. matches: type: array items: type: object required: - outputColumnName - sourceColumns properties: outputColumnName: type: string description: The name of the union output column. sourceColumns: type: array items: oneOf: - type: string - type: 'null' description: The matching set of source columns that correspond to the union output column. description: The union output columns and the matched source columns that comprise them. description: '' title: Union - allOf: - type: object required: - kind - source properties: kind: type: string enum: - transpose source: oneOf: - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Table - allOf: - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model - type: object properties: groupingId: type: string description: The identifier of the grouping to apply to the table. description: '' title: Data Model description: The identifier of the source in the transpose. - oneOf: - type: object required: - direction - outputColumns - columnToTranspose - valueColumn - aggregate properties: direction: type: string enum: - row-to-column outputColumns: type: array items: type: string description: The list of columns in the transposed table. columnToTranspose: type: string description: The identifier of the column whose values are used as column headings. valueColumn: type: string description: The identifier of the column used to calculate cell values for each row in the transposed columns. aggregate: oneOf: - type: string enum: - min - type: string enum: - max - type: string enum: - count - type: string enum: - count-if - type: string enum: - count-distinct - type: string enum: - sum - type: string enum: - avg - type: string enum: - median description: Indicates the calculation performed on the valueColumn. - type: object required: - direction - columnsToMerge - columnLabelForMergedColumns - columnLabelForValues properties: direction: type: string enum: - column-to-row columnsToMerge: type: array items: type: string description: The list of columns to merge in the transposed table. Must be of the same data type. columnLabelForMergedColumns: type: string description: The display name of the merged column in the transposed table. columnLabelForValues: type: string description: The display name of the column of transposed values. description: '' title: Transpose description: The data source for the pivot table. columns: type: array items: allOf: - allOf: - type: object required: - id - formula properties: id: type: string description: The identifier of the column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - type: object properties: image: oneOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - fixed - type: object properties: height: type: number description: Fixed image cell height in pixels. width: type: number description: Fixed image cell width in pixels. preserveAspectRatio: oneOf: - type: string enum: - preserve - type: string enum: - stretch description: When 'preserve', fit the image within height/width while keeping aspect ratio. Omit when stretched. - type: object required: - type properties: type: type: string enum: - original - type: 'null' description: Render this text column as linked images (Transform > Set image). Pass null to clear. sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Sparkline mark formatting for sparkline-type columns. - type: object properties: showOnTotals: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Whether value labels appear on total cells for this measure: ''shown'' or ''hidden''. Omit when shown (default). Pivot value columns only.' description: The columns used by the pivot table. values: type: array items: type: string description: The column IDs used as value measures. - type: object properties: name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. align: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Title alignment: ''start'', ''middle'', or ''end''.' description: 'Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: ''hidden'' }` to hide the title. Supports embedded {{formula}} interpolation in `text`.' description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Pivot description (subtitle / tooltip text) plus optional styling. noDataText: type: string description: Custom message rendered when the chart has no data. rowsBy: type: array items: allOf: - type: object required: - id properties: id: type: string description: The column ID placed on this shelf position. - type: object properties: sort: allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: by: type: string description: Column ID to sort by, or "row-count" to sort by number of rows. If omitted, sorts by the column values themselves. aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation function for custom sort. Only valid when "by" references a column ID (not "row-count"). description: Sort order for this shelf entry. showValuesAggregatedAt: type: string enum: - every-parent-row description: Aggregate row subtotals at every parent row. Omit for the default (only immediate parent row). description: Column IDs placed on the row shelf. columnsBy: type: array items: allOf: - type: object required: - id properties: id: type: string description: The column ID placed on this shelf position. - type: object properties: sort: allOf: - type: object required: - direction properties: direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: Sort direction. - type: object properties: by: type: string description: Column ID to sort by, or "row-count" to sort by number of rows. If omitted, sorts by the column values themselves. aggregation: oneOf: - type: string enum: - sum - type: string enum: - avg - type: string enum: - median - type: string enum: - count - type: string enum: - countDistinct - type: string enum: - min - type: string enum: - max - type: string enum: - stddev - type: string enum: - variance description: Aggregation function for custom sort. Only valid when "by" references a column ID (not "row-count"). description: Sort order for this shelf entry. showValuesAggregatedAt: type: string enum: - every-parent-row description: Aggregate row subtotals at every parent row. Omit for the default (only immediate parent row). description: Column IDs placed on the column shelf. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' conditionalFormats: type: array items: allOf: - oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - single - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column IDs that this formatting applies to. Must be non-empty. - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - formula properties: condition: type: string enum: - formula formula: type: string description: A Sling formula returning a boolean. The formula may reference any column on the sheet, not just the styled columns. - type: object properties: style: type: object properties: backgroundColor: type: string description: Cell background color (hex). color: type: string description: Font color (hex). bold: type: boolean italic: type: boolean underline: type: boolean format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: Number or datetime format override for the displayed value. - allOf: - type: object required: - type properties: type: type: string enum: - backgroundScale - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column IDs that this formatting applies to. Must be non-empty. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops that define the gradient. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. mid: oneOf: - type: number - type: string description: Domain midpoint. Presence selects a diverging scale; absence is sequential. order: oneOf: - type: string enum: - descending - type: string enum: - ascending nullBehavior: oneOf: - type: string enum: - asZero - type: string enum: - asNull steps: type: number description: Quantize the continuous gradient into N discrete buckets. - allOf: - type: object required: - type properties: type: type: string enum: - fontScale - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column IDs that this formatting applies to. Must be non-empty. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops that define the gradient. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. mid: oneOf: - type: number - type: string description: Domain midpoint. Presence selects a diverging scale; absence is sequential. order: oneOf: - type: string enum: - descending - type: string enum: - ascending nullBehavior: oneOf: - type: string enum: - asZero - type: string enum: - asNull steps: type: number - allOf: - type: object required: - type properties: type: type: string enum: - dataBars - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column IDs that this formatting applies to. Must be non-empty. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops that define the gradient. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. mid: oneOf: - type: number - type: string description: Domain midpoint. Presence selects a diverging scale; absence is sequential. order: oneOf: - type: string enum: - descending - type: string enum: - ascending valueLabels: oneOf: - type: string enum: - hidden - type: string enum: - shown - type: object properties: includeValues: type: boolean description: Apply this formatting to data cells. Defaults to true at render. includeSubtotals: type: boolean description: Apply this formatting to subtotal rows. Defaults to false. includeGrandTotals: type: boolean description: Apply this formatting to grand total rows. Defaults to false. description: 'Conditional formatting applied to value cells of this pivot. Order matters: later entries apply on top of earlier ones.' tableStyle: type: object properties: preset: oneOf: - type: string enum: - spreadsheet - type: string enum: - presentation description: 'Table preset: ''spreadsheet'' or ''presentation''. Omit when spreadsheet (default).' cellSpacing: oneOf: - type: string enum: - extra-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Cell spacing preset: ''extra-small'', ''small'', ''medium'', or ''large''.' gridLines: oneOf: - type: string enum: - none - type: string enum: - vertical - type: string enum: - horizontal - type: string enum: - all description: 'Grid lines: ''none'', ''vertical'', ''horizontal'', or ''all''.' banding: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Row banding visibility: ''shown'' or ''hidden''.' bandingColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' autofitColumns: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Autofit column widths (level table only): ''shown'' or ''hidden''.' outerBorder: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Outer table border: ''shown'' or ''hidden''. Maps to inverted store `hideOuterBorder`.' headerDividerColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' heavyVerticalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier vertical group dividers (pivot only): ''shown'' or ''hidden''.' heavyHorizontalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier horizontal group dividers (pivot only): ''shown'' or ''hidden''.' textStyles: type: object properties: header: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' cell: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' columnHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' rowHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' description: 'Table style: grid preset, spacing, grid lines, banding, dividers, and per-tab text styles.' sparkline: type: object properties: shape: oneOf: - type: string enum: - line - type: string enum: - bar description: 'Sparkline geometry: ''line'' or ''bar''. Omit when auto.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' interpolation: oneOf: - type: string enum: - linear - type: string enum: - monotone - type: string enum: - step - type: string enum: - step-before - type: string enum: - step-after description: 'Line interpolation: linear, monotone, step, step-before, or step-after.' missing: oneOf: - type: string enum: - zero - type: string enum: - interpolate - type: string enum: - hide description: How null values are drawn between points. line: type: object properties: style: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: ''solid'', ''dashed'', or ''dotted''.' width: oneOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 description: Stroke width in pixels (1–5). description: Line stroke for line-shaped sparklines. tooltip: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether the sparkline cell shows a hover tooltip. points: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Point markers hidden. Must not include `shape` or `size`. - type: object properties: visibility: type: string enum: - shown description: Point markers shown. Omit on read when shown; may be set explicitly on write. shape: oneOf: - type: string enum: - circle - type: string enum: - square - type: string enum: - cross - type: string enum: - diamond - type: string enum: - triangle-up description: Point marker shape. size: oneOf: - type: number enum: - 4 - type: number enum: - 9 - type: number enum: - 16 - type: number enum: - 25 - type: number enum: - 36 - type: number enum: - 64 - type: number enum: - 100 - type: number enum: - 144 - type: number enum: - 225 description: Point size by area scale (radius squared), when no size channel is bound. description: Point markers on line sparklines. labels: oneOf: - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Endpoint labels hidden. Must not include `color` or `fontSize`. - type: object properties: visibility: type: string enum: - shown description: Endpoint labels shown. Omit on read when shown; may be set explicitly on write. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontSize: type: number description: Label font size in pixels. description: Endpoint value labels on line sparklines. description: Default sparkline mark formatting applied to all sparkline columns (Format tab apply-to-all). tableComponents: type: object description: Table component visibility toggles (column headers, row headers). Each key is `shown` or `hidden`; omit when shown (default). axisTotals: type: array items: allOf: - type: object required: - axisId properties: axisId: type: string description: Pivot row or column dimension ID, or 'grand-row-total' / 'grand-column-total'. - type: object properties: calculations: type: array items: type: object required: - columnId - formula properties: columnId: type: string description: Value column ID from the pivot values shelf. formula: type: string description: Custom aggregate formula for this value column in the total row. description: Per-value custom aggregate formulas for this total. cellFormats: type: array items: allOf: - type: object required: - columnId properties: columnId: type: string description: Value column ID from the pivot values shelf. - type: object properties: align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' description: Per-value cell formatting overrides for this total. label: type: string description: Custom total label text. visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Total visibility: ''shown'' or ''hidden''. Omit when the Format tab default applies.' description: Per-axis pivot total configuration from the Totals submenu (visibility, labels, custom formulas, cell formatting). totals: type: object properties: subTotalColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' subTotalBackgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' subTotalFontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' showSubtotals: oneOf: - type: string enum: - always - type: string enum: - when-collapsed description: 'Subtotal default visibility: ''always'' (default) or ''when-collapsed''.' grandTotalColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' grandTotalBackgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' grandTotalFontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' showGrandTotals: oneOf: - type: string enum: - shown - type: string enum: - hidden totalPosition: oneOf: - type: string enum: - first - type: string enum: - last description: 'Total position: ''first'' or ''last'' (default).' description: Pivot total row/column styling and default visibility (Format tab Totals section). display: type: object properties: emptyCellDisplay: type: string description: Text shown in empty pivot value cells. measureShelfPosition: type: number description: 0-based position of the Values shelf among row/column dimension fields; -1 = last (default). repeatRowLabels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether row labels repeat on each row. rowLayout: oneOf: - type: string enum: - single-column - type: string enum: - separate-columns description: 'Row dimension layout: ''single-column'' (default, stepped) or ''separate-columns''.' showLabels: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether measure labels appear in the pivot header area. stacked: oneOf: - type: string enum: - stacked - type: string enum: - side-by-side description: 'Value layout: ''stacked'' in the row shelf or ''side-by-side'' in the column shelf (default).' headerWidths: type: object properties: columns: type: array items: type: object required: - columnId - width properties: columnId: type: string description: 'Column id: a rowsBy field id for header widths, or a pivot body leaf id for body widths.' width: type: number description: Column width in pixels. description: Per row-shelf field header widths. measureLabelWidth: type: number description: Width in pixels of the stacked measure-name column (multi-measure, stacked layout). uniformWidth: type: number description: Uniform width in pixels for all row-shelf header columns after bulk resize. description: 'Row-header column widths: bulk uniform width, per rowsBy field, and/or stacked measure-label column width.' bodyWidths: type: object properties: columns: type: array items: type: object required: - columnId - width properties: columnId: type: string description: 'Column id: a rowsBy field id for header widths, or a pivot body leaf id for body widths.' width: type: number description: Column width in pixels. description: Per pivot body leaf column widths. uniformWidth: type: number description: Uniform width in pixels for all body (value) columns after bulk resize. description: 'Body (value) column widths: bulk uniform width and/or per pivot leaf column.' description: 'Pivot display and layout: empty cell text, value stacking, measure labels, row layout, measure shelf position, repeat row labels, and column widths.' frozenColumn: oneOf: - allOf: - type: object required: - columnId properties: columnId: type: string description: The column to freeze. This column and any column visually to its left are frozen. - type: object properties: fieldValues: type: object additionalProperties: oneOf: - type: string - type: number - type: boolean - type: 'null' description: Pivot dimension values at the freeze point, keyed by column ID. - type: 'null' description: Frozen column configuration. adhocCalcs: type: array items: allOf: - type: object required: - id - inColumn - position properties: id: type: string description: Stable identifier for the ad hoc calculation row. Also the adhoc channel column ID. inColumn: type: string description: Row or column dimension from the panel “In column” field, or 'grand-row-total' / 'grand-column-total'. position: type: string enum: - above - below description: 'Panel “Position”: ''above'' or ''below'' the attach row.' - type: object properties: name: type: string description: Panel “Calculation name” (column display name). value: oneOf: - type: string - type: number - type: boolean - type: 'null' description: Panel “Select value” for the inColumn row dimension. in: type: array items: type: object required: - columnId - value properties: columnId: type: string description: Parent row or column dimension ID for this level (Format panel “In” section). value: oneOf: - type: string - type: number - type: boolean - type: 'null' description: Dimension value at this parent level. description: 'Panel “In” section: parent row dimension values above the attach level.' anchorRow: oneOf: - type: string enum: - subtotal - type: string enum: - data description: 'Anchor row or column: ''subtotal'' when placed at a subtotal or grand-total; omit for a data row or column.' calculations: type: array items: type: object required: - columnId - formula properties: columnId: type: string description: Value column ID from the pivot values shelf. formula: type: string description: Formula override for this value column in the ad hoc row. description: Per-value-column formula overrides for this ad hoc row. description: Ad hoc calculation rows or columns inserted into the pivot. folders: type: array items: allOf: - type: object required: - id - name properties: id: type: string description: The identifier of the folder. name: type: string description: The name of the folder. - type: object properties: items: type: array items: type: string description: The column and folder IDs contained within the folder. description: Folders organizing pivot columns on the row, column, and value shelves. filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this pivot table and their configurations. - type: object properties: actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. description: '' title: Pivot Table description: '' title: Data elements - allOf: - type: object required: - id - kind - text properties: id: type: string description: The identifier of the button. kind: type: string enum: - button text: type: string description: The button label. Supports dynamic-text {{formula}} references. - type: object properties: appearance: oneOf: - type: string enum: - filled - type: string enum: - outline - type: string enum: - text description: 'Visual style: filled (default), outline, or text.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right - type: string enum: - stretch description: 'Horizontal alignment: left, center, right, or stretch.' size: oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Button size: small, medium, or large.' borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner radius: square, round, or pill. Omit to inherit the workbook theme.' fillColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Background fill color: hex or theme reference.' fontColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Label text color: hex or theme reference.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Label font weight: ''normal'' or ''bold''.' actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this button. description: '' title: Button - oneOf: - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - checkbox - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - allOf: - type: object required: - mode properties: mode: oneOf: - type: string enum: - True/False - type: string enum: - True/All description: The mode of the control. - type: object properties: value: type: boolean description: The selected value in the control. description: '' title: Checkbox - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - switch - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - allOf: - type: object required: - mode properties: mode: oneOf: - type: string enum: - True/False - type: string enum: - True/All description: The mode of the control. - type: object properties: value: type: boolean description: The selected value in the control. description: '' title: Switch - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - text - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object required: - mode properties: mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. showOperators: type: boolean description: Indicates whether or not to display the control mode in the UI. value: type: string description: The text entered in the control. description: '' title: Text - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - text-area - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object properties: value: type: string description: The text entered in the control. description: '' title: Text Area - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - number - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object required: - mode properties: mode: oneOf: - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '>=' description: The operator used to filter numbers. - type: object properties: value: type: number description: The number entered in the control. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Number - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - number-range - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - date - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object required: - mode properties: mode: oneOf: - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '>=' description: The operator used to filter dates. - type: object properties: value: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The date selected in the control, in ISO 8601 or relative format. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - date-range - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date Range - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - top-n - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - oneOf: - allOf: - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - list - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. - type: object required: - source properties: source: allOf: - type: object required: - kind - source - columnId properties: kind: type: string enum: - source source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The identifier of the column used as a value source for the control. - type: object properties: displayColumnId: type: string description: The identifier of the column containing display names for the control values. - oneOf: - allOf: - type: object required: - selectionMode properties: selectionMode: type: string enum: - single - type: object properties: value: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: string description: '' title: Fixed Date description: The value selected in the control. - type: object properties: selectionMode: type: string enum: - multiple values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. - allOf: - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - list - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. - type: object properties: source: allOf: - type: object required: - kind - valueType properties: kind: type: string enum: - manual valueType: oneOf: - type: string enum: - text - type: string enum: - number - type: string enum: - date - type: string enum: - boolean description: The data type of the list values. - type: object properties: values: oneOf: - type: array items: type: boolean - type: array items: type: number - type: array items: type: string - type: array items: type: string description: '' title: Fixed Date description: The list of possible values in the control. labels: type: array items: oneOf: - type: string - type: 'null' description: The list of labels applied to the values in the control. - oneOf: - allOf: - type: object required: - selectionMode properties: selectionMode: type: string enum: - single - type: object properties: value: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: string description: '' title: Fixed Date description: The value selected in the control. - type: object properties: selectionMode: type: string enum: - multiple values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List values - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - segmented - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object properties: clearLabel: type: string description: The text displayed for the clear option if showClearLabel is true. showClearLabel: type: boolean description: Indicates whether or not to include a clear option in the control. source: oneOf: - allOf: - type: object required: - kind - valueType properties: kind: type: string enum: - manual valueType: oneOf: - type: string enum: - text - type: string enum: - number - type: string enum: - date - type: string enum: - boolean description: The data type of the list values. - type: object properties: values: oneOf: - type: array items: type: boolean - type: array items: type: number - type: array items: type: string - type: array items: type: string description: '' title: Fixed Date description: The list of possible values in the control. labels: type: array items: oneOf: - type: string - type: 'null' description: The list of labels applied to the values in the control. description: '' title: Manual - allOf: - type: object required: - kind - source - columnId properties: kind: type: string enum: - source source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The identifier of the column used as a value source for the control. - type: object properties: displayColumnId: type: string description: The identifier of the column containing display names for the control values. description: '' title: Source description: The source of the possible values in the control. - type: object properties: value: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: string description: '' title: Fixed Date description: The value selected in the control. description: '' title: Segmented Control - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - hierarchy - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object properties: source: type: object required: - source - columnId properties: source: type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table columnId: type: string mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: '' title: Hierarchy - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - slider - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object required: - mode properties: mode: oneOf: - type: string enum: - <= - type: string enum: - '=' - type: string enum: - '>=' description: The comparison operator used by the control. - type: object properties: low: type: number description: The minimum value of the slider. high: type: number description: The maximum value of the slider. step: type: number description: The amount the slider increments by between steps. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: value: type: number description: The number selected in the control. description: '' title: Slider - allOf: - allOf: - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: The identifier of the control. controlId: type: string description: The identifier used to reference this control in a formula. controlType: type: string enum: - range-slider - type: object properties: name: type: string description: 'The display name. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' filters: type: array items: type: object required: - source - columnId properties: source: oneOf: - type: object required: - kind - elementId properties: kind: type: string enum: - table elementId: type: string description: The identifier of the table in this data model. description: '' title: Table - allOf: - type: object required: - connectionId - path properties: connectionId: type: string description: The identifier of the connection to the data platform. path: type: array items: type: string description: The path of the object in the data platform. - type: object required: - kind properties: kind: type: string enum: - warehouse-table description: '' title: Warehouse Table - type: object required: - dataModelId - elementId - kind properties: dataModelId: type: string description: The identifier of the data model source. elementId: type: string description: The identifier of the table in the referenced data model. kind: type: string enum: - data-model description: '' title: Data Model description: The source targeted by this control. columnId: type: string description: The column targeted by this control. description: The filter targets of the control parameters: type: array items: type: object required: - kind - dataModelId - controlId properties: kind: type: string enum: - data-model dataModelId: type: string description: The identifier of the data model. controlId: type: string description: The identifier of the control. description: The data model control that this control targets and overrides. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual styling: background color, border, rounded corners, and padding toggle.' - type: object properties: low: type: number description: The minimum value of the slider. high: type: number description: The maximum value of the slider. step: type: number description: The amount the slider increments by between steps. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Range Slider - type: object required: - kind - id - controlId - controlType properties: kind: type: string enum: - control id: type: string description: This synced copy's own element id. controlId: type: string description: The controlId of the primary control this copy mirrors. controlType: type: string enum: - synced description: '' title: Synced description: '' title: Control - allOf: - type: object required: - id - kind properties: id: type: string description: The identifier of the divider. kind: type: string enum: - divider - type: object properties: direction: oneOf: - type: string enum: - horizontal - type: string enum: - vertical description: Orientation of the divider. Defaults to horizontal. align: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: Alignment along the cross-axis. Defaults to middle. style: type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Stroke color as a hex string (e.g. "#e0e0e0") or theme reference. width: type: number description: Stroke thickness in pixels. strokeStyle: oneOf: - type: string enum: - solid - type: string enum: - dashed - type: string enum: - dotted description: 'Stroke pattern: solid, dashed, or dotted.' description: Visual customization of the divider stroke. description: '' title: Divider - type: object required: - id - kind - url properties: id: type: string description: The identifier of the embed. kind: type: string enum: - embed url: type: string description: The URL to embed. Supports dynamic `{{formula}}` references. description: '' title: Embed - allOf: - type: object required: - id - kind - source properties: id: type: string description: The identifier of the image. kind: type: string enum: - image source: oneOf: - type: object required: - kind - url properties: kind: type: string enum: - url url: type: string description: An external image URL. Supports {{formula}} dynamic-text references. description: An external image referenced by URL. title: External URL - type: object required: - kind - key properties: kind: type: string enum: - upload key: type: string description: Opaque handle for an image uploaded into Sigma (storage key). Emitted by GET and accepted by PUT; not a fetchable URL. description: 'A reference to an image already uploaded into Sigma. Reference-only: the handle points at an existing upload; the spec cannot upload a new one.' title: Uploaded Image description: 'The image source: an external URL (supports {{formula}} references) or an image uploaded into Sigma.' - type: object properties: alt: type: string description: Alternative text for the image. style: allOf: - allOf: - type: object properties: fit: oneOf: - type: string enum: - contain - type: string enum: - cover - type: string enum: - none - type: string enum: - scale-down - type: string enum: - stretch description: 'How the image fits its container: contain, cover, none, scale-down, or stretch.' horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Horizontal alignment within the container: start, middle, or end.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment within the container: start, middle, or end.' tiling: oneOf: - type: string enum: - none - type: string enum: - repeat description: 'Tiling behavior: ''none'' (single image, default) or ''repeat'' (tiled to fill the container).' - type: object properties: shape: oneOf: - type: string enum: - rectangle - type: string enum: - circle description: 'Image shape: rectangle or circle.' - oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Visual customization: fit, alignment, shape, and tiling.' - type: object properties: actions: type: array items: allOf: - type: object required: - id - trigger - effects properties: id: type: string description: The stable identifier for this action sequence. trigger: oneOf: - type: string enum: - on-click - type: string enum: - on-select - type: string enum: - on-primary-cta-click - type: string enum: - on-secondary-cta-click - type: string enum: - on-close description: The event that fires this action. effects: type: array items: oneOf: - allOf: - type: object required: - effect - openTarget properties: effect: type: string enum: - open-url openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the URL opens: _self (same tab), _blank (new tab), or _parent (parent frame).' - type: object properties: url: type: string description: The URL to open. Supports dynamic-text {{formula}} references. description: Opens a URL in the same tab, a new tab, or the parent frame. title: Open URL - type: object required: - effect - overlayId properties: effect: type: string enum: - open-overlay overlayId: type: string description: The identifier of the overlay to open. Must reference a modal or drawer page. description: Opens a modal overlay page. title: Open Overlay - type: object required: - effect properties: effect: type: string enum: - close-overlay description: Closes the currently open modal overlay. title: Close Overlay - allOf: - type: object required: - effect - control - value properties: effect: type: string enum: - set-control-value control: type: string description: The controlId of the control to set. value: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput description: The value to set. - type: object properties: selectionMode: oneOf: - type: string enum: - replace - type: string enum: - add - type: string enum: - remove description: 'How the value combines with the current selection: replace (default), add, or remove.' description: Sets a control's value, optionally combining with the current selection. title: Set Control Value - allOf: - type: object required: - effect - scope properties: effect: type: string enum: - clear-control scope: oneOf: - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Clear a single control, by its controlId. title: Control - type: object required: - type - container properties: type: type: string enum: - container container: type: string description: Clear every control in a container, by the container element id. title: Container - allOf: - type: object required: - type properties: type: type: string enum: - page - type: object properties: page: type: string description: Clear every control on a page (the page id, or the current page when omitted). title: Page - type: object required: - type properties: type: type: string enum: - workbook description: Clear every control in the workbook. title: Workbook description: What to clear. - type: object properties: usePublishedValue: type: boolean description: Reset to the published value instead of empty. description: Clears one or more controls to empty or their published value. title: Clear Control - type: object required: - effect - table - values properties: effect: type: string enum: - insert-rows table: type: string description: The element id of the target input-table to insert into. Must not be a linked input table. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write. Every column present here is set; columns omitted are left to the table's own default. description: Inserts a row into a target input table. title: Insert Rows - type: object required: - effect - table - whichRows - values properties: effect: type: string enum: - update-rows table: type: string description: The element id of the target input-table. May be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to update. values: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Column id (on the target table) -> the value to write into the matched rows. description: Updates matched rows in a target input table. title: Update Rows - type: object required: - effect - table - whichRows properties: effect: type: string enum: - delete-rows table: type: string description: The element id of the target input-table. Must not be a linked input table. whichRows: oneOf: - type: object required: - type - primaryKeys properties: type: type: string enum: - single-row primaryKeys: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Match one row by its primary-key column values (column id -> value source). - type: object required: - type properties: type: type: string enum: - current-row description: The row the trigger fired from (host must be a descendant of the target input table). - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: Match rows where this formula (over the target table columns) is true. - allOf: - type: object required: - type - column properties: type: type: string enum: - column-match column: type: string - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean description: Match rows where the target-table column meets the condition. description: Which rows to delete. description: Deletes matched rows from a target input table. title: Delete Rows - type: object required: - effect - target properties: effect: type: string enum: - refresh-element target: type: object required: - type - element properties: type: type: string enum: - element element: type: string description: What to refresh. description: Refreshes a single element. title: Refresh Element - type: object required: - effect - target properties: effect: type: string enum: - navigate target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: The page or element to navigate to, in this workbook. description: Navigate to a page or element in this workbook. title: Navigate - allOf: - type: object required: - effect - document - openTarget - documentType properties: effect: type: string enum: - open-document document: type: string description: The inode id of the workbook or report to open. openTarget: oneOf: - type: string enum: - _self - type: string enum: - _blank - type: string enum: - _parent description: 'Where the document opens: _self (same tab), _blank (new tab), or _parent (parent frame).' documentType: oneOf: - type: string enum: - workbook - type: string enum: - report description: The kind of document `document` refers to — selects the route the runtime opens (workbook vs report). - type: object properties: target: oneOf: - type: object required: - type - page properties: type: type: string enum: - page page: type: string description: A page, by its page id. title: Page - type: object required: - type - element properties: type: type: string enum: - element element: type: string description: An element, by its element id. title: Element description: A page or element to open inside the target document. Its id lives in that document and is passed through verbatim (not validated against this workbook). targetControls: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - constant value: oneOf: - type: object required: - type - value properties: type: type: string enum: - text value: oneOf: - type: string - type: 'null' description: A text value, or null for empty. description: '' title: Text - type: object required: - type - value properties: type: type: string enum: - number value: oneOf: - type: number - type: 'null' description: A number value, or null for empty. description: '' title: Number - type: object required: - type - value properties: type: type: string enum: - boolean value: oneOf: - type: boolean - type: 'null' description: A boolean value, or null for empty. description: '' title: Boolean - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative - type: 'null' description: A date value (ISO 8601 fixed or relative), or null for empty. description: '' title: Date - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: 'null' - type: string description: '' title: Text list - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: 'null' - type: number description: '' title: Number list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: '' title: Date list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: type: array items: oneOf: - type: string enum: - is-true - type: string enum: - is-false - type: string enum: - is-null description: '' title: Boolean list - type: object required: - type - value properties: type: type: string enum: - number-range value: type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number range - type: object required: - type - value properties: type: type: string enum: - date-range value: oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom description: '' title: Date range description: A literal value, typed to the target control. title: Constant - type: object required: - type - control properties: type: type: string enum: - control control: type: string description: Copy another control's current value, referenced by its controlId. title: Control - type: object required: - type - formula properties: type: type: string enum: - formula formula: type: string description: A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger. title: Formula - type: object required: - type - column properties: type: type: string enum: - column column: type: string description: A column on the host element's source (select triggers). title: Column - allOf: - type: object required: - type properties: type: type: string enum: - column-range - type: object properties: min: type: string max: type: string description: Min and/or max columns on the host element's source, for a range control (select triggers). title: ColumnRange - allOf: - type: object required: - type properties: type: type: string enum: - formula-range - type: object properties: min: type: string max: type: string description: Min and/or max formula expressions, for a range control. May reference [Selection / col] on a select trigger. title: FormulaRange - type: object required: - type - inputName properties: type: type: string enum: - agent-input inputName: type: string description: A clear label for the value the agent should provide, such as 'Customer name'. description: A value provided by an agent when it runs this action. Use only with an action tool for an agent. title: AgentInput type: object description: Target-document control variableName -> the value to pass in. Values are resolved against this workbook (this action's host); the keys name controls in the opened document. description: Opens another workbook or report. title: Open Document - type: object required: - effect - tabbedContainer - selectedTab properties: effect: type: string enum: - select-tab tabbedContainer: type: string description: The tabbed-container element to select a tab on. selectedTab: oneOf: - type: object required: - type - direction properties: type: type: string enum: - direction direction: oneOf: - type: string enum: - next - type: string enum: - previous description: Selects the next or previous tab, relative to the currently active tab. title: Direction - type: object required: - type - index properties: type: type: string enum: - tab index: type: number description: 0-based index into the container's tab order. description: Selects a specific tab, by its 0-based position in the container's tab order. title: Tab description: Which tab to select. description: Selects a tab on a tabbed-container element. title: Select Tab description: Ordered effects that run when the trigger fires. - type: object properties: name: type: string description: Optional display name for the action. state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: 'Whether the action runs: ''enabled'' (default) or ''disabled''.' description: Actions triggered by interacting with this element. description: '' title: Image - allOf: - type: object required: - id - kind - source - inputMode properties: id: type: string description: Identifier of the input-table element. kind: type: string enum: - input-table source: oneOf: - allOf: - type: object required: - kind - connectionId properties: kind: type: string enum: - empty connectionId: type: string description: The identifier of the connection used to provision the input-table. - type: object properties: writebackSchema: type: array items: type: string description: For connections with multiple writeback schemas (e.g. OAuth), the schema to provision the input-table into, given as the schema scope path — e.g. `["MY_DB", "MY_SCHEMA"]`, or a single-element array on warehouses with a one-part path. Must match a writeback schema configured on the connection and accessible to the requesting user. Omit on single-schema connections to use the default. Create-time only. - allOf: - type: object required: - kind - from properties: kind: type: string enum: - linked from: type: string description: Id of another element in the spec whose data this input-table links to. Editable rows are matched to source rows by the `key` columns. The connection is inherited from that element. - type: object properties: writebackSchema: type: array items: type: string description: For connections with multiple writeback schemas (e.g. OAuth), the schema to provision the input-table into, given as the schema scope path — e.g. `["MY_DB", "MY_SCHEMA"]`, or a single-element array on warehouses with a one-part path. Must match a writeback schema configured on the connection and accessible to the requesting user. Omit on single-schema connections to use the default. Create-time only. description: Source of the input-table. `empty` provisions a fresh warehouse table. inputMode: oneOf: - type: string enum: - edit description: workbook editors only, in draft mode - type: string enum: - explore description: users with explore or greater permission, in published view - type: string enum: - view description: all users, in published view description: data entry permissions - type: object properties: name: oneOf: - type: string - type: object required: - visibility properties: visibility: type: string enum: - hidden description: Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior). - allOf: - type: object required: - text properties: text: type: string description: 'Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. "Total: {{Count() | ,.0f}}".' - type: object properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Title font weight: ''normal'' or ''bold''.' fontSize: type: number description: Title font size in pixels. align: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Title alignment: ''start'', ''middle'', or ''end''.' description: 'Display title. A bare string, an object `{ text, ...styling }` for font size/color/alignment/weight, or `{ visibility: "hidden" }` to hide the title.' description: oneOf: - type: string - type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Set to 'hidden' to hide the description while keeping stored text. Omit when shown. text: type: string description: Description text. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Description font weight: ''normal'' or ''bold''.' position: oneOf: - type: string enum: - auto - type: string enum: - below - type: string enum: - tooltip description: 'Where the description renders: ''auto'', ''below'' (subtitle), or ''tooltip''. Default ''auto''.' fontSize: type: number description: Description font size in pixels. description: Description (subtitle / tooltip text) plus optional styling. A bare string for text-only. style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: 'Element style: background color, border, border radius, and padding.' noDataText: type: string description: Label displayed when the input table has no data. tableComponents: type: object properties: table: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Input table body grid. summaryBar: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Input table summary bar. description: Visibility of the table grid and summary bar. tableStyle: type: object properties: preset: oneOf: - type: string enum: - spreadsheet - type: string enum: - presentation description: 'Table preset: ''spreadsheet'' or ''presentation''. Omit when spreadsheet (default).' cellSpacing: oneOf: - type: string enum: - extra-small - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: 'Cell spacing preset: ''extra-small'', ''small'', ''medium'', or ''large''.' gridLines: oneOf: - type: string enum: - none - type: string enum: - vertical - type: string enum: - horizontal - type: string enum: - all description: 'Grid lines: ''none'', ''vertical'', ''horizontal'', or ''all''.' banding: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Row banding visibility: ''shown'' or ''hidden''.' bandingColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' autofitColumns: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Autofit column widths (level table only): ''shown'' or ''hidden''.' outerBorder: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Outer table border: ''shown'' or ''hidden''. Maps to inverted store `hideOuterBorder`.' headerDividerColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' heavyVerticalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier vertical group dividers (pivot only): ''shown'' or ''hidden''.' heavyHorizontalDividers: oneOf: - type: string enum: - shown - type: string enum: - hidden description: 'Heavier horizontal group dividers (pivot only): ''shown'' or ''hidden''.' textStyles: type: object properties: header: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' cell: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' columnHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' rowHeader: type: object properties: font: type: string description: Font family name. fontSize: type: number description: Font size in pixels. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: "theme", ref: "colors-xxx" }`.' align: oneOf: - type: string enum: - left - type: string enum: - center - type: string enum: - right description: 'Horizontal text alignment: left, center, or right.' verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical text alignment: ''start'', ''middle'', or ''end''.' textWrap: oneOf: - type: string enum: - wrap - type: string enum: - clip description: 'Text overflow: ''wrap'' or ''clip''.' description: 'Table style: grid preset, spacing, grid lines, banding, autofit, dividers, and per-tab text styles.' columns: type: array items: oneOf: - allOf: - type: object required: - id properties: id: oneOf: - type: string enum: - ID - type: string enum: - CREATED_AT - type: string enum: - CREATED_BY - type: string enum: - UPDATED_AT - type: string enum: - UPDATED_BY description: Protocol-managed system column id (e.g. `ID`, `CREATED_AT`). Its data type is fixed by the input-table protocol. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - allOf: - type: object required: - id - key properties: id: type: string description: Identifier of the key column in this input-table. key: type: string description: Id of the source column (on `source.from`) this key binds to. Immutable once the input-table is created. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - allOf: - type: object required: - id - type properties: id: type: string description: Warehouse column identifier. type: oneOf: - type: string enum: - text - type: string enum: - number - type: string enum: - datetime - type: string enum: - checkbox - type: string enum: - multi-select - type: string enum: - file description: Data type of the column. - type: object properties: values: type: array items: oneOf: - type: string - type: number - type: boolean description: Allowed values for the column, presented as a single-select dropdown. valuesFrom: type: object required: - element - column properties: element: type: string description: Id of a sibling element supplying the option values. column: type: string description: Id of the column on that element to read values from. description: Column-sourced option list (alternative to inline `values`). range: oneOf: - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. - type: object properties: min: type: string description: The selected date to filter on, in ISO 8601 format. max: type: string description: The selected date to filter on, in ISO 8601 format. description: Min/max bound for a number or datetime column (datetime bounds are ISO-8601 dates). maxFileNum: type: number description: Maximum number of files per cell (file columns only). maxFileSizeMb: type: number description: Maximum size per file in MB, 1–200 (file columns only). acceptedFileTypes: type: array items: type: string description: Allowed file MIME types (file columns only); an absent or empty list accepts everything. Passing any one MIME type of a multi-format family (e.g. `application/msword`) selects the whole family, so a round-trip may expand the list to every MIME type in each selected family. pills: oneOf: - type: string enum: - single-color - type: string enum: - color-by-option description: 'Display a select column as pills. `single-color`: one shared color; `color-by-option`: a color per option. Absent shows plain text.' - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. - allOf: - type: object required: - id - formula properties: id: type: string description: Identifier of the formula column. formula: type: string description: The reference or calculation for the column. - type: object properties: name: type: string description: The display name of the column. description: type: string description: The description of the column. hidden: type: boolean description: Indicates whether or not the column is hidden from view. format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: The display format of the column. description: Columns of the input-table. conditionalFormats: type: array items: oneOf: - allOf: - type: object required: - type properties: type: type: string enum: - single - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column IDs that this formatting applies to. Must be non-empty. - oneOf: - type: object required: - condition properties: condition: oneOf: - type: string enum: - IsNull - type: string enum: - IsNotNull - type: object required: - condition - value properties: condition: oneOf: - type: string enum: - '=' - type: string enum: - '!=' - type: string enum: - '>' - type: string enum: - '>=' - type: string enum: - < - type: string enum: - <= - type: string enum: - Contains - type: string enum: - NotContains - type: string enum: - StartsWith - type: string enum: - EndsWith value: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - low - high properties: condition: oneOf: - type: string enum: - Between - type: string enum: - NotBetween low: oneOf: - type: string - type: number - type: boolean high: oneOf: - type: string - type: number - type: boolean - type: object required: - condition - formula properties: condition: type: string enum: - formula formula: type: string description: A Sling formula returning a boolean. The formula may reference any column on the sheet, not just the styled columns. - type: object properties: style: type: object properties: backgroundColor: type: string description: Cell background color (hex). color: type: string description: Font color (hex). bold: type: boolean italic: type: boolean underline: type: boolean format: oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number - type: object properties: formatString: type: string description: The format of the number specified in d3 format. prefix: type: string description: The prefix to apply to the number. suffix: type: string description: The suffix to apply to the number. displayNullAs: type: string description: The display value to show for null values. - type: object properties: decimalSymbol: type: string description: The character used for decimal notation. digitGroupingSymbol: type: string description: The character used to separate digits in large numbers. digitGroupingSize: type: array items: type: number description: The interval at which to use the digit grouping symbol. currencySymbol: type: string description: The characters used for currency. - allOf: - type: object required: - kind properties: kind: type: string enum: - datetime - type: object properties: formatString: type: string description: The format of the date specified in d3 time format. description: Number or datetime format override for the displayed value. - allOf: - type: object required: - type properties: type: type: string enum: - backgroundScale - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column IDs that this formatting applies to. Must be non-empty. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops that define the gradient. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. mid: oneOf: - type: number - type: string description: Domain midpoint. Presence selects a diverging scale; absence is sequential. order: oneOf: - type: string enum: - descending - type: string enum: - ascending nullBehavior: oneOf: - type: string enum: - asZero - type: string enum: - asNull steps: type: number description: Quantize the continuous gradient into N discrete buckets. - allOf: - type: object required: - type properties: type: type: string enum: - fontScale - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column IDs that this formatting applies to. Must be non-empty. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops that define the gradient. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. mid: oneOf: - type: number - type: string description: Domain midpoint. Presence selects a diverging scale; absence is sequential. order: oneOf: - type: string enum: - descending - type: string enum: - ascending nullBehavior: oneOf: - type: string enum: - asZero - type: string enum: - asNull steps: type: number - allOf: - type: object required: - type properties: type: type: string enum: - dataBars - type: object required: - columnIds properties: columnIds: type: array items: type: string description: Column IDs that this formatting applies to. Must be non-empty. - type: object properties: scheme: type: array items: type: string description: Array of 2+ hex color stops that define the gradient. domain: type: object properties: min: oneOf: - type: number - type: string description: Domain minimum. Numeric literal, or a Sling formula string. max: oneOf: - type: number - type: string description: Domain maximum. Numeric literal, or a Sling formula string. mid: oneOf: - type: number - type: string description: Domain midpoint. Presence selects a diverging scale; absence is sequential. order: oneOf: - type: string enum: - descending - type: string enum: - ascending valueLabels: oneOf: - type: string enum: - hidden - type: string enum: - shown description: 'Conditional formatting applied to columns of this input-table. Order matters: later entries apply on top of earlier ones.' summary: type: array items: type: string description: Identifiers of the columns shown as aggregates in the summary bar. Each id must also be defined in `columns`. sort: type: array items: allOf: - type: object required: - columnId - direction properties: columnId: type: string description: The identifier of the column by which to sort. direction: oneOf: - type: string enum: - ascending - type: string enum: - descending description: The direction in which to sort. - type: object properties: nulls: oneOf: - type: string enum: - first - type: string enum: - last - type: string enum: - connection-default description: Indicates how the sort order treats null values. description: The column, direction, and null behavior used to sort the rows of this input-table. filters: type: array items: allOf: - type: object required: - id - columnId properties: id: type: string description: The identifier of the filter. columnId: type: string description: The identifier of the column this filter targets. - type: object properties: state: oneOf: - type: string enum: - enabled - type: string enum: - disabled description: Indicates whether or not the filter is enabled. - oneOf: - allOf: - type: object required: - kind properties: kind: type: string enum: - number-range - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. - type: object properties: min: type: number description: The lower bound of the selected number range. max: type: number description: The upper bound of the selected number range. description: '' title: Number Range - allOf: - type: object required: - kind properties: kind: type: string enum: - date-range - oneOf: - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - between startDate: type: string description: The start date of the date range, in ISO 8601 format. endDate: type: string description: The end date of the date range, in ISO 8601 format. - type: object required: - mode properties: mode: type: string enum: - between description: '' title: Between - type: object required: - mode - date properties: mode: type: string enum: - 'on' date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: 'On' - type: object required: - mode - date properties: mode: type: string enum: - before date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: Before - type: object required: - mode - date properties: mode: type: string enum: - after date: type: string description: The date to filter to, in ISO 8601 format. description: '' title: After - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - next value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Next - type: object required: - mode - value - unit - includeToday properties: mode: type: string enum: - last value: type: number description: The number of units to filter on. I.e. 'x units ago'. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. includeToday: type: boolean description: Indicates whether or not to include the current date. description: '' title: Last - type: object required: - mode - unit properties: mode: type: string enum: - current unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. description: '' title: Current - oneOf: - type: object required: - mode - startDate - endDate properties: mode: type: string enum: - custom startDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The start date of the date range, in ISO 8601 or relative format. endDate: oneOf: - type: string description: '' title: Fixed - type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: '' title: Relative description: The end date of the date range, in ISO 8601 or relative format. - type: object required: - mode - startDate properties: mode: type: string enum: - custom startDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The start date of the date range, in relative format. Use this variant when the end date is unbounded. - type: object required: - mode - endDate properties: mode: type: string enum: - custom endDate: type: object required: - op - unit - value properties: op: oneOf: - type: string enum: - now-minus - type: string enum: - now-plus description: Indicates whether to filter for the relative range before or after the date. unit: oneOf: - type: string enum: - year - type: string enum: - quarter - type: string enum: - month - type: string enum: - week-starting-sunday - type: string enum: - week-starting-monday - type: string enum: - day - type: string enum: - hour - type: string enum: - minute description: The unit of time to filter on. value: type: number description: The number of units to filter on. I.e. 'x units ago' or 'in x units'. description: The end date of the date range, in relative format. Use this variant when the start date is unbounded. description: '' title: Custom - type: object properties: includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Date Range - allOf: - type: object required: - kind properties: kind: type: string enum: - top-n - oneOf: - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank - type: string enum: - rank-dense - type: string enum: - row-number description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-n - type: string enum: - bottom-n description: Indicates whether to filter top or bottom N values. - type: object properties: rowCount: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Row Count - allOf: - type: object required: - rankingFunction - mode properties: rankingFunction: oneOf: - type: string enum: - rank-percentile - type: string enum: - cume-dist description: The type of ranking this filter uses. mode: oneOf: - type: string enum: - top-percentile - type: string enum: - bottom-percentile description: Indicates whether to filter top or bottom N values. - type: object properties: percentile: type: number description: The number of top results to return. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Percentile description: '' title: Top N - allOf: - type: object required: - kind properties: kind: type: string enum: - list - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: oneOf: - type: array items: oneOf: - type: 'null' - type: boolean description: The list of selected booleans. Can contain null. title: boolean - type: array items: oneOf: - type: 'null' - type: number description: The list of selected numbers. Can contain null. title: number - type: array items: oneOf: - type: 'null' - type: string description: The list of selected strings. Can contain null. title: string - type: array items: oneOf: - type: 'null' - type: string description: The selected date to filter on, in ISO 8601 format. description: The list of selected dates in ISO 8601 format. Can contain null. title: datetime description: The list of selected values in the filter. description: '' title: List - allOf: - type: object required: - kind - mode properties: kind: type: string enum: - text-match mode: oneOf: - type: string enum: - equals - type: string enum: - does-not-equal - type: string enum: - contains - type: string enum: - does-not-contain - type: string enum: - starts-with - type: string enum: - does-not-start-with - type: string enum: - ends-with - type: string enum: - does-not-end-with - type: string enum: - like - type: string enum: - not-like - type: string enum: - matches-regexp - type: string enum: - does-not-match-regexp description: Indicates the type of text comparison to make. - type: object properties: value: type: string description: The string to compare against. case: oneOf: - type: string enum: - sensitive - type: string enum: - insensitive description: Indicates whether the text comparison is case 'sensitive' or 'insensitive'. includeNulls: oneOf: - type: string enum: - always - type: string enum: - never - type: string enum: - when-no-value-is-selected description: Indicates when to include null values. description: '' title: Text Match - allOf: - type: object required: - kind properties: kind: type: string enum: - hierarchy - type: object properties: mode: oneOf: - type: string enum: - include - type: string enum: - exclude description: Indicates whether to 'include' or 'exclude' the list of values. values: type: array items: type: array items: type: string description: The hierarchy paths selected by the filter. description: '' title: Hierarchy description: The filters applied to this input-table and their configurations. description: '' title: Input Table - allOf: - type: object required: - id - kind - pluginId properties: id: type: string description: The identifier of the plugin element. kind: type: string enum: - plugin pluginId: type: string description: Identifier of the custom plugin to render in this element. - type: object properties: displayName: type: string description: Display name for the plugin element. config: type: object additionalProperties: oneOf: - type: string - type: boolean - type: array items: type: string - oneOf: - allOf: - type: object required: - kind - elementId properties: kind: type: string enum: - element elementId: type: string description: The identifier of the element that provides data to the plugin. - type: object properties: groupingId: type: string description: The identifier of a grouping on the source element to read data at. Omit to read ungrouped (base) data. description: '' title: Element reference - allOf: - type: object required: - kind - source properties: kind: type: string enum: - column source: type: string description: Name of the element-reference config entry that provides the columns. - oneOf: - type: object required: - columnId properties: columnId: type: string description: The identifier of a single column in the source element. - type: object required: - columnIds properties: columnIds: type: array items: type: string description: The identifiers of columns in the source element. description: '' title: Column reference - type: object required: - kind - controlId properties: kind: type: string enum: - control controlId: type: string description: The identifier of the control whose value feeds this config entry. description: '' title: Control reference description: Plugin inputs, keyed by the config name the plugin declares. Values are literals, or `kind`-tagged references to elements, columns, or controls. The set of meaningful keys is defined by the plugin itself at runtime and is not validated here. style: type: object properties: backgroundColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Background color as a hex string (e.g. "#ffffff") or theme reference. description: Visual customization of the plugin element. description: '' title: Plugin - allOf: - type: object required: - id - kind properties: id: type: string description: The identifier of the progress element. kind: type: string enum: - progress - type: object properties: shape: oneOf: - type: string enum: - bar - type: string enum: - ring description: Render as a horizontal 'bar' or a 'ring'. Defaults to 'bar'. mode: oneOf: - type: string enum: - percent - type: string enum: - value description: Fill by 'percent' (value relative to min/max) or by raw 'value'. Defaults to 'percent'. value: type: string description: Formula for the current value, e.g. `Sum([Sales])` or `42`. min: type: string description: Formula for the lower bound of the range. max: type: string description: Formula for the upper bound of the range. config: type: object properties: style: oneOf: - allOf: - type: object required: - padding properties: padding: type: string enum: - none description: Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change. - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' - type: object properties: backgroundColor: type: string description: Element background color (hex). borderRadius: oneOf: - type: string enum: - square - type: string enum: - round - type: string enum: - pill description: 'Corner rounding: ''square'', ''round'', or ''pill''.' borderWidth: type: number description: 'Border width in pixels. Cannot be set when `padding: ''none''`.' borderColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: 'Border color (hex or theme reference). Cannot be set when `padding: ''none''`.' description: Element background, border, and padding. format: type: object properties: fillColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color of the filled portion of the bar/ring. trackColor: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Color of the unfilled track behind the fill. size: oneOf: - type: string enum: - small - type: string enum: - medium - type: string enum: - large description: Thickness of the bar or diameter tier of the ring. horizontalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: Horizontal alignment of the bar/ring within the element. verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: Vertical alignment of the bar/ring within the element. description: Fill/track colors, size, and alignment of the bar/ring. label: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether this text is 'shown' or 'hidden'. text: type: string description: Text content. Supports embedded formulas in `{{double braces}}`; plain text otherwise. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to size with the element. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Text color. description: Styling for the label text. value: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether this text is 'shown' or 'hidden'. text: type: string description: Text content. Supports embedded formulas in `{{double braces}}`; plain text otherwise. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to size with the element. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Text color. description: Styling for the value text. description: type: object properties: visibility: oneOf: - type: string enum: - shown - type: string enum: - hidden description: Whether this text is 'shown' or 'hidden'. text: type: string description: Text content. Supports embedded formulas in `{{double braces}}`; plain text otherwise. fontWeight: oneOf: - type: string enum: - normal - type: string enum: - bold description: 'Font weight: ''normal'' or ''bold''.' fontSize: oneOf: - type: number - type: string enum: - auto description: Font size in pixels, or 'auto' to size with the element. color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Text color. description: Styling for the description text. colorRules: type: array items: oneOf: - type: object required: - color - formula properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Fill color applied when the formula is true. formula: type: string description: Boolean formula; the color applies when it evaluates true. - allOf: - type: object required: - color properties: color: oneOf: - type: string - type: object required: - kind - ref properties: kind: type: string enum: - theme ref: type: string description: Fill color applied when the condition holds. - oneOf: - type: object required: - condition - value properties: condition: type: string enum: - '=' - '!=' - '>' - '>=' - < - <= value: type: number - type: object required: - condition - low - high properties: condition: type: string enum: - Between - NotBetween low: type: number high: type: number - type: object properties: applyTo: oneOf: - type: string enum: - value - type: string enum: - percentage description: Compare against the raw 'value' (default) or the filled 'percentage'. description: Conditional fill colors, evaluated top to bottom. description: Visual customization of the progress bar. description: '' title: Progress - allOf: - type: object required: - id - kind - body properties: id: type: string description: The identifier of the text element. kind: type: string enum: - text body: type: string description: 'Markdown body. Supports a deliberate subset: paragraphs, headings (#, ##, ###), bullet/ordered lists, soft and hard breaks, **bold**, *italic*, ~~strikethrough~~, [links](url) (open in a new window by default; use for same-window), inline HTML /// carrying any of color, background-color (hex), font-size (integer px), and font-family, plus {{formula}} segments (same {{ast | fmt}} syntax used by element titles). Paragraph alignment and the p-large/p-small block styles use a

wrapper, e.g.

(aligned headings too:

); unaligned headings stay #/##/### and default paragraphs stay bare. UI-authored features outside this subset (list-item color) come back as their closest supported neighbor on read.' - type: object properties: verticalAlign: oneOf: - type: string enum: - start - type: string enum: - middle - type: string enum: - end description: 'Vertical alignment of body content within the tile: ''start'' (top), ''middle'', or ''end'' (bottom). Default ''start''.' overflow: oneOf: - type: string enum: - clip - type: string enum: - scroll description: 'Overflow behavior when content exceeds the tile: ''clip'' (cut off, default) or ''scroll'' (scrollbar).' description: '' title: Text DashVariables: type: object additionalProperties: oneOf: - type: object required: - type - value properties: type: type: string enum: - boolean value: type: - boolean - 'null' description: '' title: boolean - type: object required: - type - value properties: type: type: string enum: - number value: type: - number - 'null' description: '' title: number - type: object required: - type - value properties: type: type: string enum: - text value: type: - string - 'null' description: '' title: text - type: object required: - type - value properties: type: type: string enum: - date value: oneOf: - type: 'null' - type: object required: - type - date properties: type: type: string enum: - fixed date: type: number - type: object required: - type - unit - x properties: type: type: string enum: - prior - next unit: type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second x: type: number description: '' title: date - type: object required: - type - value properties: type: type: string enum: - number-list value: type: array items: oneOf: - type: number - type: 'null' description: '' title: number-list - type: object required: - type - value properties: type: type: string enum: - text-list value: type: array items: oneOf: - type: string - type: 'null' description: '' title: text-list - type: object required: - type - value properties: type: type: string enum: - date-list value: type: array items: oneOf: - type: number - type: 'null' description: '' title: date-list - type: object required: - type - value properties: type: type: string enum: - boolean-list value: allOf: - type: object required: - 'true' - 'false' properties: 'true': type: boolean 'false': type: boolean - type: object properties: 'null': type: boolean description: '' title: boolean-list - type: object required: - type - min - max properties: type: type: string enum: - date-range min: oneOf: - type: 'null' - type: object required: - type - date properties: type: type: string enum: - fixed date: type: number - type: object required: - type - unit - x properties: type: type: string enum: - prior - next unit: type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second x: type: number max: oneOf: - type: 'null' - type: object required: - type - date properties: type: type: string enum: - fixed date: type: number - type: object required: - type - unit - x properties: type: type: string enum: - prior - next unit: type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second x: type: number description: '' title: date-range - type: object required: - type - min - max properties: type: type: string enum: - number-range min: type: - number - 'null' max: type: - number - 'null' description: '' title: number-range - type: object required: - type properties: type: type: string enum: - date-null description: '' title: date-null - type: object required: - type properties: type: type: string enum: - number-null description: '' title: number-null - type: object required: - type properties: type: type: string enum: - text-null description: '' title: text-null - type: object required: - type properties: type: type: string enum: - boolean-null description: '' title: boolean-null - type: object required: - type - value properties: type: type: string enum: - hierarchical-list value: type: array items: type: string description: '' title: hierarchical-list - type: object required: - type - value properties: type: type: string enum: - file value: type: object required: - id - name - size - type - downloadUrl properties: id: type: string name: type: string size: type: number type: type: string downloadUrl: type: string description: '' title: file - type: object required: - type properties: type: type: string enum: - file-null description: '' title: file-null - type: object required: - type - value properties: type: type: string enum: - file-list value: type: array items: type: object required: - id - name - size - type - downloadUrl properties: id: type: string name: type: string size: type: number type: type: string downloadUrl: type: string description: '' title: file-list type: object DataTypes: oneOf: - type: object required: - type properties: type: type: string enum: - 'null' description: '' title: 'Null' - type: object required: - type - val properties: type: type: string enum: - bool val: type: boolean description: Set data value description: '' title: Boolean - type: object required: - type - val properties: type: type: string enum: - number val: type: number description: Set data value description: '' title: Number - type: object required: - type - val properties: type: type: string enum: - string val: type: string description: Set data value description: '' title: String - type: object required: - type - val properties: type: type: string enum: - integer val: type: string description: Set data value description: '' title: Integer - type: object required: - type - val properties: type: type: string enum: - datetime val: type: string description: Set data value description: '' title: DateTime - type: object required: - type - val properties: type: type: string enum: - error val: type: string description: Set data value description: '' title: Error - type: object required: - type - val properties: type: type: string enum: - record val: type: object additionalProperties: $ref: '#/components/schemas/DataTypes' description: Set data value description: '' title: Record - type: object required: - type - val properties: type: type: string enum: - variant val: type: string description: '' title: Variant - type: object required: - type - val properties: type: type: string enum: - array val: oneOf: - type: object required: - type - data properties: type: type: string enum: - boolArr data: type: array items: type: - boolean - 'null' - type: object required: - type - data properties: type: type: string enum: - numberArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bigintArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - stringArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - datetimeArr data: type: array items: type: - number - 'null' - type: object required: - type - data properties: type: type: string enum: - bytesArr data: type: array items: type: - string - 'null' - type: object required: - type - data properties: type: type: string enum: - variantArr data: type: array items: type: - string - 'null' description: '' title: Array description: Set a constant value for condition ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItems2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type' mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value' required: - type - mode - columnId - op title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItems2 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout : type: string enum: - portrait - landscape title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables9: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf9Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables9 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf0Type: type: string enum: - isEmpty description: Type of condition title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNull - IsNotNull - Contains - StartsWith - EndsWith description: Operator title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Op ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0 DataTypesOneOf9ValOneOf2Type: type: string enum: - bigintArr title: DataTypesOneOf9ValOneOf2Type V2WorkbooksWorkbookIdGetResponsesContentApplicationJsonSchemaTagsItems: type: object properties: versionTagId: type: string description: Unique identifier of the tag. name: type: string sourceWorkbookVersion: type: number format: double taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. workbookTaggedAt: type: string format: date-time required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt title: V2WorkbooksWorkbookIdGetResponsesContentApplicationJsonSchemaTagsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DashboardSettings: type: object properties: filters: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DashboardSettingsFiltersItems' variableValues: $ref: '#/components/schemas/DashVariables_2' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DashboardSettings V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type' tileId: type: string mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value' required: - type - tileId - mode - columnId - op title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems2 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf0Type' elementId: type: string required: - type - elementId description: Export one element title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource0 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2FormattingPivotHeaderStyle: type: string enum: - merged - repeated title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2FormattingPivotHeaderStyle ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf1Type' value: type: string required: - type - value description: Integer value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value1 workbooks_getWorkbookControls_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_getWorkbookControls_Response_200 V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormatOneOf1Unit: type: string enum: - pixels - inches - centimeters description: Unit for the `width` and `height` values. title: V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormatOneOf1Unit ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type' nodeIds: type: array items: type: string required: - type - nodeIds description: Export multiple elements title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf1Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf6Type' required: - type description: No export format options title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions6 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf5Type : type: string enum: - text-list title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf5Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type' sheetId: type: string required: - type - sheetId title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems1 V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType3: type: string enum: - date title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType3 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables12: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf12Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables12 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type' elementId: type: string required: - type - elementId description: Export one element title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource0 V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2FormatOneOf0Layout: type: string enum: - portrait - landscape title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2FormatOneOf0Layout ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf4Type: type: string enum: - PDF title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf4Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf1Type' required: - type description: JSONL export format options title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3Type' value: type: array items: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3ValueItemsItems' description: 'Array of hierarchy paths. Each path is an array of segments, from the highest selected level of the hierarchy down to the lowest selected level of the hierarchy. Each segment is a `{type: "text", value: string}` object. For example, a Region/State/City hierarchy control with Oakland selected would be represented as `[[{"type":"text","value":"West"}, {"type":"text","value":"California"}, {"type":"text","value":"Oakland"}]]`' required: - type - value description: Hierarchical list value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues3 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type : type: string enum: - NONE title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf0Type' date: type: string description: ISO-8601 date string required: - type - date description: Fixed date selection title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min0 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf4Layout : type: string enum: - portrait - landscape title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf4Layout ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf1Type' unit: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf1Unit' x: type: number format: double required: - type - unit - x description: Relative date selection, for example "Next 4 days" title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value1 DashVariablesOneOf6Type: type: string enum: - date-list title: DashVariablesOneOf6Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf0Type: type: string enum: - always title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf0Type V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItemsOneOf1Type' description: Dataset (deprecated) inodeId: type: string url: type: string description: URL to open this dataset in Sigma. required: - type - inodeId - url title: V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems1 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables13: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf13Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables13 V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaWarningsItemsDetailsItems: type: object properties: type: type: string description: Element type, in kebab-case. count: type: number format: double description: Number of affected elements of this type. sourceElementIds: type: array items: type: string description: IDs of the affected elements in the source workbook. reportElementIds: type: array items: type: string description: IDs of the affected elements in the new report. parent: $ref: '#/components/schemas/V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaWarningsItemsDetailsItemsParent' description: The unsupported parent that caused this element to drop, if applicable. required: - type - count title: V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaWarningsItemsDetailsItems ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf2Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Type: type: string enum: - workbook title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf3Type : type: string enum: - boolean-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf3Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItems: type: object properties: scheduledNotificationId: type: string description: Unique identifier of the scheduled export. workbookId: type: string description: Unique identifier of the workbook. schedule: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsSchedule' configV2: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2' isSuspended: type: boolean description: Whether the schedule is currently suspended. ownerId: type: string description: Unique identifier of the user who owns the schedule. lastUpdatedByUser: type: string description: Unique identifier of the user who last updated the schedule. disabledAt: type: - string - 'null' format: date-time description: Timestamp when the schedule was disabled, or null if the schedule is active. disabledBy: type: - string - 'null' description: Unique identifier of the member who disabled the schedule, or null if the schedule is active. createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. required: - scheduledNotificationId - workbookId - schedule - configV2 - isSuspended - ownerId - lastUpdatedByUser - disabledAt - disabledBy - createdBy - updatedBy - createdAt - updatedAt title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItems V2WorkbooksWorkbookIdQueriesGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: elementId: type: string name: type: string sql: type: string error: type: string required: - elementId title: V2WorkbooksWorkbookIdQueriesGetResponsesContentApplicationJsonSchemaEntriesItems V2WorkbooksWorkbookIdRestoreVersionPostResponsesContentApplicationJsonSchemaTagsItems: type: object properties: versionTagId: type: string description: Unique identifier of the tag. name: type: string sourceWorkbookVersion: type: number format: double taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. workbookTaggedAt: type: string format: date-time required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt title: V2WorkbooksWorkbookIdRestoreVersionPostResponsesContentApplicationJsonSchemaTagsItems V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2: type: object properties: title: type: string messageBody: type: string notificationAttachments: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItems' includeLink: type: boolean runAsRecipient: type: boolean attachmentSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2AttachmentSettings' conditionOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions' alertConfig: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2AlertConfig' notificationName: type: string dashboardSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DashboardSettings' dynamicExportSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettings' dynamicRecipientSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicRecipientSettings' rowLimit: type: number format: double workbookVariant: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2WorkbookVariant' embedOpts: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2EmbedOpts' formatting: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2Formatting' - type: 'null' required: - title - messageBody - notificationAttachments title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf0Type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - worksheet title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions6' description: Export format options title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf3Type' slackConversationId: type: string required: - type - slackConversationId title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems3 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicRecipientSettings: type: object properties: sourceNodeId: type: string recipientColumnId: type: string required: - sourceNodeId - recipientColumnId title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicRecipientSettings ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf7Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables7 DataTypesOneOf9Val1: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf9ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: DataTypesOneOf9Val1 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf4Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables4 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf2Type : type: string enum: - text title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf2Type V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf3Type' connectionId: type: - string - 'null' name: type: - string - 'null' definition: type: string required: - type - connectionId - name - definition title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems3 DashVariables14: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf14Type' value: type: array items: type: string required: - type - value title: DashVariables14 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type : type: string enum: - chartColumn title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0Format1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0FormatOneOf1Type' layout: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0FormatOneOf1Layout' required: - type - layout description: Export options for PDF title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0Format1 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AlertConfigWindow: type: string enum: - alltime - daily - weekly - always title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AlertConfigWindow ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf0Type : type: string enum: - element title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type' tileId: type: string required: - type - tileId title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems1 V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaSourceWorkbook: type: object properties: workbookId: type: string description: Unique identifier of the source workbook. name: type: string description: Name of the source workbook. url: type: string description: URL of the source workbook. required: - workbookId - name - url title: V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaSourceWorkbook ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type : type: string enum: - NONE title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2AttachmentSettings: type: object properties: mergePdfAttachments: type: boolean zipAttachments: type: boolean title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2AttachmentSettings ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2AlertConfig: type: object properties: window: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2AlertConfigWindow' volume: type: - number - 'null' format: double required: - window title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2AlertConfig V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItems: type: object properties: formatOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions' chartId: type: string workbookExportSource: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource' required: - formatOptions title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItems V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaEdgesItems: type: object properties: source: type: string target: type: string type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaEdgesItemsType' required: - source - target - type title: V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaEdgesItems ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf1Type : type: string enum: - page title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type workbooks_convertWorkbookToReport_Response_201: type: object properties: convertedReport: $ref: '#/components/schemas/V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaConvertedReport' sourceWorkbook: $ref: '#/components/schemas/V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaSourceWorkbook' warnings: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaWarningsItems' description: Warnings about content that could not be carried over to the report. May be empty. required: - convertedReport - sourceWorkbook - warnings title: workbooks_convertWorkbookToReport_Response_201 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DashboardSettingsFiltersItems: type: object properties: id: type: string filterStr: type: string required: - id - filterStr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DashboardSettingsFiltersItems DataTypesOneOf9Val6: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf9ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: DataTypesOneOf9Val6 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2Type: type: string enum: - worksheet title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2Type V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1Format2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1FormatOneOf2Type' required: - type description: Export options for EXCEL documents title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1Format2 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf0Type' date: type: string description: ISO-8601 date string required: - type - date description: Fixed date selection title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value0 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type' nodeIds: type: array items: type: string required: - type - nodeIds description: Export multiple pages title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource3 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf12Type: type: string enum: - text-null title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf12Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettings: type: object properties: variables: type: object additionalProperties: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettings V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0FormatOneOf0Type: type: string enum: - csv - jsonl - json - xlsx title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0FormatOneOf0Type V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType5: type: string enum: - text-list title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType5 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf1Type' pageIds: type: array items: type: string description: Array of page identifiers to export required: - type - pageIds description: Export multiple pages title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions2' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions3' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions4' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions5' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions6' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookVariant: type: object properties: tagId: type: string description: Version tag to export bookmarkId: type: string description: Bookmark to export description: Workbook variant title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookVariant ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type : type: string enum: - JSONL title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value DataTypesOneOf9Val5: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf9ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: DataTypesOneOf9Val5 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf0Type : type: string enum: - isEmpty description: Type of condition title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf0Type DataTypesOneOf9Val4: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf9ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: DataTypesOneOf9Val4 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf5Type: type: string enum: - PNG title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf5Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf6Type : type: string enum: - NONE title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf6Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf3Type: type: string enum: - page title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type' nodeIds: type: array items: type: string required: - type - nodeIds description: Export multiple pages title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource3 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables5: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf5Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type : type: string enum: - page title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables12: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf12Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables12 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf0Type : type: string enum: - element title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6 workbooks_listLineageTree_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_listLineageTree_Response_200 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf3Type : type: string enum: - date title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type : type: string enum: - chartColumn title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type : type: string enum: - element title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type DashVariablesOneOf3ValueOneOf0Type: type: string enum: - fixed title: DashVariablesOneOf3ValueOneOf0Type DashVariablesOneOf16Type: type: string enum: - file-null title: DashVariablesOneOf16Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems1 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type' sheetId: type: string required: - type - sheetId title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItemsOneOf0Type : type: string enum: - text title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0 V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaConnectionMappingItemsPathsItems: type: object properties: fromPath: type: array items: type: string description: Connection path of the form ['DATABASE', 'SCHEMA', 'TABLE'] toPath: type: array items: type: string description: Connection path of the form ['DATABASE', 'SCHEMA', 'TABLE'] required: - fromPath - toPath title: V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaConnectionMappingItemsPathsItems V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DashboardSettings: type: object properties: filters: type: array items: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DashboardSettingsFiltersItems' variableValues: $ref: '#/components/schemas/DashVariables_2' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DashboardSettings ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type : type: string enum: - PDF title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf6Type : type: string enum: - date-list title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf6Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues4: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Type' min: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min' description: Date selection max: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max' description: Date selection required: - type - min - max description: Date range value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues4 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AlertConfigWindow: type: string enum: - alltime - daily - weekly - always title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AlertConfigWindow ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf7Type : type: string enum: - boolean-list title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf7Type workbooks_exportWorkbook_Response_200: type: object properties: jobComplete: type: boolean queryId: type: string rows: type: array items: type: object additionalProperties: description: Any type message: type: string required: - jobComplete - queryId title: workbooks_exportWorkbook_Response_200 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf1Value: type: object properties: 'true': type: boolean 'false': type: boolean 'null': type: boolean required: - 'true' - 'false' title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf1Value ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItemsOneOf1Type' required: - type description: Null date value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type DashVariablesOneOf8Min0: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf8MinOneOf0Type' date: type: number format: double required: - type - date title: DashVariablesOneOf8Min0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf0Type' elementIds: type: array items: type: string description: Array of element identifiers to export required: - type - elementIds description: Export multiple elements title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource0 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2Formatting: type: object properties: pivotHeaderStyle: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2FormattingPivotHeaderStyle' description: Style of pivot table headers includeMetadata: type: boolean description: Whether to include metadata in XLSX exports description: Export formatting options title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2Formatting ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf2Type : type: string enum: - text-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val DashVariables_2: oneOf: - $ref: '#/components/schemas/DashVariables0' - $ref: '#/components/schemas/DashVariables1' - $ref: '#/components/schemas/DashVariables2' - $ref: '#/components/schemas/DashVariables3' - $ref: '#/components/schemas/DashVariables4' - $ref: '#/components/schemas/DashVariables5' - $ref: '#/components/schemas/DashVariables6' - $ref: '#/components/schemas/DashVariables7' - $ref: '#/components/schemas/DashVariables8' - $ref: '#/components/schemas/DashVariables9' - $ref: '#/components/schemas/DashVariables10' - $ref: '#/components/schemas/DashVariables11' - $ref: '#/components/schemas/DashVariables12' - $ref: '#/components/schemas/DashVariables13' - $ref: '#/components/schemas/DashVariables14' - $ref: '#/components/schemas/DashVariables15' - $ref: '#/components/schemas/DashVariables16' - $ref: '#/components/schemas/DashVariables17' title: DashVariables ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type : type: string enum: - PDF title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues20: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0Type' value: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems' required: - type - value description: Number list value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues20 ? V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExportOneOf0ExportFormat : type: string enum: - csv - csv.gzip title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExportOneOf0ExportFormat ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2 V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType9: type: string enum: - number-range title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType9 workbooks_getWorkbookBookmarks_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdBookmarksGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_getWorkbookBookmarks_Response_200 DashVariablesOneOf3ValueOneOf1Unit: type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second title: DashVariablesOneOf3ValueOneOf1Unit ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf11Type : type: string enum: - number-null title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf11Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExport0: type: object properties: bq: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExportOneOf0Bq' required: - bq title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExport0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1 DashVariablesOneOf2Type: type: string enum: - text title: DashVariablesOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type : type: string enum: - EXCEL title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4 V2WorkbooksWorkbookIdTagVersionTagCopyPostRequestBodyContentApplicationJsonSchemaCopyBookmarks: type: string enum: - all - accessible description: If set to `all` (available to admins only), every saved view (bookmark) applied to the workbook is copied. If set to `accessible`, only personal saved views and those shared with the user initiating the operation are copied. Ownership of all saved views in the duplicate workbook transfers to the user initiating the operation. If not set, saved views are not copied. title: V2WorkbooksWorkbookIdTagVersionTagCopyPostRequestBodyContentApplicationJsonSchemaCopyBookmarks ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions6 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource4' title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource workbooks_getTaggedWorkbookBookmarks_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdTagsTagNameBookmarksGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_getTaggedWorkbookBookmarks_Response_200 V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2FormatOneOf0Type: type: string enum: - pdf title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2FormatOneOf0Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf2Type' required: - type description: Export all content title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource2 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3Type: type: string enum: - dashboard title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables6: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf6Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables6 DashVariables2: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf2Type' value: type: - string - 'null' required: - type - value title: DashVariables2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItems : type: object properties: formatOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions' chartId: type: string workbookExportSource: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource' required: - formatOptions title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicRecipientSettings: type: object properties: sourceNodeId: type: string recipientColumnId: type: string required: - sourceNodeId - recipientColumnId title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicRecipientSettings ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf1Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0 ? V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExportOneOf1ConnectionType : type: string enum: - bigQuery title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExportOneOf1ConnectionType ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf1Type' unit: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf1Unit' x: type: number format: double required: - type - unit - x description: Relative date selection, for example "Next 4 days" title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type : type: string enum: - all title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0Items: type: object properties: scheduledNotificationId: type: string description: Unique identifier of the scheduled export. workbookId: type: string description: Unique identifier of the workbook. schedule: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsSchedule' configV2: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2' isSuspended: type: boolean description: Whether the schedule is currently suspended. ownerId: type: string description: Unique identifier of the user who owns the schedule. lastUpdatedByUser: type: string description: Unique identifier of the user who last updated the schedule. disabledAt: type: - string - 'null' format: date-time description: Timestamp when the schedule was disabled, or null if the schedule is active. disabledBy: type: - string - 'null' description: Unique identifier of the member who disabled the schedule, or null if the schedule is active. createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. required: - scheduledNotificationId - workbookId - schedule - configV2 - isSuspended - ownerId - lastUpdatedByUser - disabledAt - disabledBy - createdBy - updatedBy - createdAt - updatedAt title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0Items ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf0Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf2Type : type: string enum: - text title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf2Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf2Type' email: type: string required: - type - email title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Type: type: string enum: - workbook title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues00 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf0Type' value: type: boolean required: - type - value description: Boolean value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues00 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type : type: string enum: - element title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type : type: string enum: - JSON title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf2Type : type: string enum: - text title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf2Type V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaEdgesItemsType: type: string enum: - lookup - source - dependency title: V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaEdgesItemsType ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues6: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues60' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues61' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues62' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues63' description: Null value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues6 workbooks_shareWorkbookCrossOrg_Response_200: type: object properties: {} title: workbooks_shareWorkbookCrossOrg_Response_200 DashVariables7: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf7Type' value: $ref: '#/components/schemas/DashVariablesOneOf7Value' required: - type - value title: DashVariables7 V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf2Type' connectionId: type: - string - 'null' name: type: - string - 'null' inodeId: type: string required: - type - connectionId - name - inodeId title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems2 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItems: type: object properties: formatOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions' source: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource' required: - formatOptions - source title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type' nodeIds: type: array items: type: string required: - type - nodeIds description: Export multiple elements title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource2 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2WorkbookVariant: type: object properties: tagId: type: string exploreKey: type: string bookmarkId: type: string title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2WorkbookVariant ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource4' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf4Layout: type: string enum: - portrait - landscape title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf4Layout ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf10Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf10Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type WorkbooksListMaterializationSchedulesResponse2001: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItems' nextPage: type: - string - 'null' required: - entries - nextPage title: WorkbooksListMaterializationSchedulesResponse2001 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf1Type: type: string enum: - team title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf1Type V2WorkbooksTagPostRequestBodyContentApplicationJsonSchemaSourceMappingConfigItems: type: object properties: fromConnectionId: type: string toConnectionId: type: string paths: type: array items: $ref: '#/components/schemas/V2WorkbooksTagPostRequestBodyContentApplicationJsonSchemaSourceMappingConfigItemsPathsItems' required: - fromConnectionId - toConnectionId - paths title: V2WorkbooksTagPostRequestBodyContentApplicationJsonSchemaSourceMappingConfigItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5 DashVariablesOneOf3Value0: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf3ValueOneOf0Type' date: type: number format: double required: - type - date title: DashVariablesOneOf3Value0 DataTypesOneOf9Val2: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf9ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: DataTypesOneOf9Val2 V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf7Type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - worksheet title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf7Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1Type: type: string enum: - workbook title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions4: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf4Type' layout: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf4Layout' scaleFactor: type: number format: double required: - type title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions4 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions6 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions6 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9 V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2Format: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2Format0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2Format1' title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2Format ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItemsOneOf0Type : type: string enum: - fixed-date title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf2Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2FormattingPivotHeaderStyle: type: string enum: - merged - repeated title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2FormattingPivotHeaderStyle ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf7Type : type: string enum: - boolean-list title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf7Type V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormatOneOf1PageSize: type: string enum: - custom description: Use a custom page size. title: V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormatOneOf1PageSize ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Type : type: string enum: - date-range title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf0Type : type: string enum: - boolean title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type : type: string enum: - queryColumn title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems1' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues00: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf0Type' value: type: boolean required: - type - value description: Boolean value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues00 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems1 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type' tileId: type: string required: - type - tileId title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type' required: - type description: Export all pages and elements in a workbook title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource4 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf3Type' required: - type description: XLSX export format options title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions3 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExportOneOf0Bq: type: object properties: bqDestination: type: string required: - bqDestination title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExportOneOf0Bq ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf6Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables6 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Type' condition: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition' required: - type - condition description: Send the export based on a condition title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions1 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6 V2WorkbooksWorkbookIdVersionHistoryGetResponsesContentApplicationJsonSchemaEntriesItemsTagsItems: type: object properties: versionTagId: type: string taggedAt: type: string format: date-time taggedBy: type: string required: - versionTagId - taggedAt - taggedBy title: V2WorkbooksWorkbookIdVersionHistoryGetResponsesContentApplicationJsonSchemaEntriesItemsTagsItems V2WorkbooksWorkbookIdElementsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: elementId: type: string name: type: string type: type: string columns: type: array items: type: string vizualizationType: type: string error: type: string required: - elementId title: V2WorkbooksWorkbookIdElementsGetResponsesContentApplicationJsonSchemaEntriesItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4 DataTypesOneOf8Type: type: string enum: - variant title: DataTypesOneOf8Type workbooks_updateTaggedWorkbookBookmark_Response_200: type: object properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. isDefault: type: boolean description: Whether the bookmark is default. required: - bookmarkId - name - isShared - exploreKey title: workbooks_updateTaggedWorkbookBookmark_Response_200 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf0Type' required: - type description: CSV export format options title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions0 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions0 V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType10: type: string enum: - date-null title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType10 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf0Type : type: string enum: - boolean title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables11 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf11Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables11 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type' sheetId: type: string required: - type - sheetId title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems1 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2EmbedOpts: type: object properties: embedId: type: string evalConnectionId: type: string title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2EmbedOpts ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1Type: type: string enum: - workbook title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions1 V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType12: type: string enum: - text-null title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType12 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf4Type: type: string enum: - all title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf4Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExport2: type: object properties: rs: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExportOneOf2Rs' required: - rs title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExport2 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions5: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf5Type' pixelWidth: type: - number - 'null' format: double pixelHeight: type: - number - 'null' format: double required: - type title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions5 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables12: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf12Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables12 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DashboardSettings: type: object properties: filters: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DashboardSettingsFiltersItems' variableValues: $ref: '#/components/schemas/DashVariables_2' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DashboardSettings ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions0 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaSchedule: type: object properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. description: When to send the workbook export. title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaSchedule V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2Formatting: type: object properties: pivotHeaderStyle: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2FormattingPivotHeaderStyle' description: Style of pivot table headers includeMetadata: type: boolean description: Whether to include metadata in XLSX exports description: Export formatting options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2Formatting ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4 workbooks_createWorkbookEmbed_Response_200: type: object properties: embedId: type: string description: Unique identifier of the embed. embedUrl: type: string required: - embedId - embedUrl title: workbooks_createWorkbookEmbed_Response_200 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf2Type : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf2Type DashVariablesOneOf3Value: oneOf: - $ref: '#/components/schemas/DashVariablesOneOf3Value0' - $ref: '#/components/schemas/DashVariablesOneOf3Value1' title: DashVariablesOneOf3Value ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9 workbooks_deleteTaggedWorkbookBookmark_Response_200: type: object properties: {} title: workbooks_deleteTaggedWorkbookBookmark_Response_200 DataTypesOneOf3Type: type: string enum: - string title: DataTypesOneOf3Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues6: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues60' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues61' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues62' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues63' description: Null value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues6 V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2Format1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2FormatOneOf1Type' required: - type description: Export options for EXCEL documents title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2Format1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3Type' value: type: array items: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3ValueItemsItems' description: 'Array of hierarchy paths. Each path is an array of segments, from the highest selected level of the hierarchy down to the lowest selected level of the hierarchy. Each segment is a `{type: "text", value: string}` object. For example, a Region/State/City hierarchy control with Oakland selected would be represented as `[[{"type":"text","value":"West"}, {"type":"text","value":"California"}, {"type":"text","value":"Oakland"}]]`' required: - type - value description: Hierarchical list value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues3 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource0 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type' elementId: type: string required: - type - elementId description: Export one element title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1 workbooks_v2_1_listWorkbookSchedules_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItems' description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. total: type: number format: double description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' required: - entries - nextPage title: workbooks_v2_1_listWorkbookSchedules_Response_200 WorkbooksListWorkbookSchedulesResponse2000: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0Items' title: WorkbooksListWorkbookSchedulesResponse2000 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf9Type : type: string enum: - number-range title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf9Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExport0: type: object properties: connectionType: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExportOneOf0ConnectionType' authorization: type: string uri: type: string exportFormat: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExportOneOf0ExportFormat' timestampedUri: type: - string - 'null' required: - connectionType - authorization - uri - exportFormat - timestampedUri title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExport0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems0 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0 DashVariables4: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf4Type' value: type: array items: type: - number - 'null' format: double required: - type - value title: DashVariables4 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf4Type: type: string enum: - gsheet title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Mode : type: string enum: - any - all description: Kind of condition evaluation title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Mode ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf4Type : type: string enum: - number-list title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf4Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7 V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType2: type: string enum: - text title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type' sheetId: type: string required: - type - sheetId title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf1Type : type: string enum: - isNotEmpty description: Type of condition title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf1Type workbooks_createTaggedWorkbookBookmark_Response_200: type: object properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. isDefault: type: boolean description: Whether the bookmark is default. required: - bookmarkId - name - isShared - exploreKey title: workbooks_createTaggedWorkbookBookmark_Response_200 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExport: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExport0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExport1' title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExport ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type : type: string enum: - PNG title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf6Type: type: string enum: - NONE title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf6Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf5Type : type: string enum: - text-list title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf5Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Type' conditions: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems' required: - type - conditions title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions1 workbooks_listLineage_Response_200: type: object properties: dependencies: type: object additionalProperties: $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies' edges: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaEdgesItems' required: - dependencies - edges title: workbooks_listLineage_Response_200 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf13Type : type: string enum: - boolean-null title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf13Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type' mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value' required: - type - mode - columnId - op title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems2 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type : type: string enum: - CSV title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems1' title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type workbooks_deleteWorkbookSchedule_Response_200: type: object properties: {} title: workbooks_deleteWorkbookSchedule_Response_200 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type : type: string enum: - element title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type' tileId: type: string required: - type - tileId title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItems1 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2EmbedOpts: type: object properties: embedId: type: string evalConnectionId: type: string title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2EmbedOpts ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems2' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition2' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf1Type : type: string enum: - JSONL title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems8' title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables10 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf10Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables10 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf1Unit : type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf1Unit ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type' nodeIds: type: array items: type: string required: - type - nodeIds description: Export multiple pages title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource3 V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItemsOneOf0Type' dataModelId: type: string elementIds: type: array items: type: string versionTagId: type: string required: - type - dataModelId - elementIds title: V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems0 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf2Type' required: - type description: Null date value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min2 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type' nodeIds: type: array items: type: string required: - type - nodeIds description: Export multiple pages title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource3 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItems: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItems2' description: Send based on conditions title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type : type: string enum: - sheetColumn title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3Type: type: string enum: - hierarchical-list title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems2 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type' sheetId: type: string mode: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value' required: - type - sheetId - mode - columnId - op title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems2 V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType6: type: string enum: - date-list title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType6 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type : type: string enum: - NONE title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf13Type : type: string enum: - boolean-null title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf13Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicRecipientSettings: type: object properties: sourceNodeId: type: string recipientColumnId: type: string required: - sourceNodeId - recipientColumnId title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicRecipientSettings ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type' mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value' required: - type - mode - columnId - op title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1FormatOneOf2Type: type: string enum: - xlsx title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1FormatOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf4Type : type: string enum: - number-list title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf4Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2Type: type: string enum: - worksheet title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2Type DataTypes0: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf0Type' required: - type title: DataTypes0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions1 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions1 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf10Type: type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf10Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions4: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf4Type' layout: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf4Layout' required: - type description: PDF export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions4 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type DashVariablesOneOf7Type: type: string enum: - boolean-list title: DashVariablesOneOf7Type V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItemsColumnMappingItems: type: object properties: fromColumn: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItemsColumnMappingItemsFromColumn' toColumn: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItemsColumnMappingItemsToColumn' required: - fromColumn - toColumn title: V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItemsColumnMappingItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItems2' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf0Type' date: type: string description: ISO-8601 date string required: - type - date description: Fixed date selection title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max0 workbooks_getWorkbookTags_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdTagsGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_getWorkbookTags_Response_200 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type' tileId: type: string required: - type - tileId title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems0 DashVariablesOneOf8MinOneOf0Type: type: string enum: - fixed title: DashVariablesOneOf8MinOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf2Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables2 workbooks_getTaggedWorkbookBookmark_Response_200: type: object properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. isDefault: type: boolean description: Whether the bookmark is default. required: - bookmarkId - name - isShared - exploreKey title: workbooks_getTaggedWorkbookBookmark_Response_200 DashVariables5: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf5Type' value: type: array items: type: - string - 'null' required: - type - value title: DashVariables5 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type : type: string enum: - sheetColumn title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1FormatOneOf0Layout: type: string enum: - portrait - landscape title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1FormatOneOf0Layout ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type' pageId: type: string required: - type - pageId description: Export one page title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource1 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8Type: type: string enum: - workbook-cloud-export title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1 DashVariables3: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf3Type' value: oneOf: - $ref: '#/components/schemas/DashVariablesOneOf3Value' - type: 'null' required: - type - value title: DashVariables3 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6 V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItems: type: object properties: fromId: type: string description: ID of the dataset (deprecated) or table to swap from. toId: type: string description: ID of the dataset (deprecated) or table to swap to. metricMapping: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItemsMetricMappingItems' columnMapping: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItemsColumnMappingItems' required: - fromId - toId title: V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type' tileId: type: string mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value' required: - type - tileId - mode - columnId - op title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3ValueItemsItems : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3ValueItemsItemsType' value: type: string required: - type - value description: Text value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3ValueItemsItems V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0: type: object properties: memberId: type: string required: - memberId description: The UUID of the member receiving the grant title: V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables6: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf6Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables6 workbooks_sourceSwapWorkbook_Response_200: type: object properties: unswappedSources: type: array items: type: string description: IDs of sources in the workbook that were not swapped. unswappedConnections: type: array items: type: string description: IDs of custom SQL connections in the workbook that were not swapped. required: - unswappedSources - unswappedConnections title: workbooks_sourceSwapWorkbook_Response_200 DashVariablesOneOf17Type: type: string enum: - file-list title: DashVariablesOneOf17Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions6' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout : type: string enum: - portrait - landscape title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItems1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type : type: string enum: - sheetColumn title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Type: type: string enum: - workbook title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type workbooks_postWorkbookBookmarks_Response_200: type: object properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. isDefault: type: boolean description: Whether the bookmark is default. required: - bookmarkId - name - isShared - exploreKey title: workbooks_postWorkbookBookmarks_Response_200 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues6' description: Variable value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItemsOneOf1Type' required: - type description: Null number value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems1 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf0Type: type: string enum: - element title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5 V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType13: type: string enum: - boolean-null title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType13 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2FormatOneOf1Type: type: string enum: - xlsx title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2FormatOneOf1Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables4: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf4Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables4 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4 WorkbooksExportWorkbookRequest1: type: object properties: pageId: type: string description: Identifier of the workbook page. format: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1Format' parameters: type: object additionalProperties: type: string description: "Specify the control ID and control value of one or more control elements in the workbook or report to filter the returned data. The control must exist in the Sigma workbook or report and target an element before you can export based on the control value.\n\n**Syntax**\n{ control-id: control-value }\n\nThe control-id is configured in the Sigma workbook or report. The control-value is the value that is passed to the control.\n\nValues can take multiple forms, depending on the data type of the control:\n\n**Boolean**\n\n- Single value: \"true\" | \"false\" | \":null\"\n- List of Boolean: \"true,false,:null\" (No space after the comma.)\n\n**Number**\n\n- Single value: \"10.54\", \":null\"\n- List of values: \"10.54,23.45,:null\" (No space after the comma.)\n- Range of numbers: \"min:10.54,max:23.45\" (No space after the comma or colon.)\n\n**Text**\n\n- Single value: \"some-text\" | \":null\" | \":empty\"\n- List of values: \"some-text,more-text,:null,:empty\" (No space after the comma.)\n\n**Date**\n\nAll dates use UTC time zones.\n\n- Fixed date using ISO-6801 format: \"2022-01-01T01:01:59\" | \":null\"\n - Formats supported (where: %Y: year, %m: month, %d: day, %H:hours, %M: minutes, %S: seconds):\n - %Y-%m-%d\n - %Y-%m-%dT%H:%M\n - %Y-%m-%dT%H:%M:%S\n- List of fixed dates: \"2022-01-01T01:01:59,2022-02-02T02:02:59,:null\"\n- Relative date: \"prior-day-3\" | \"next-day-3\"\n - Format: [prior|next]-[year|quarter|month|week|isoWeek|day|hour|minute]-[number]\n- Date range: \"min:2022-01-01T01:01:59,max:next-day-3\" (No spaces after the comma or colon.)\n - Leave max blank for \"on or after\" and min blank for \"on or before\", for example:\n - \"Date-Range\": \"min:2020-04-01,max:\"\n - \"Date-Range\": \"min:,max:next-day-3\"\n\n**Notes**\n\n- \":null\" is a special value that denotes the null primitive value.\n- \":empty\" is a special value that denotes the empty string \"\".\n\nUse [URL encoding](https://help.sigmacomputing.com/docs/special-characters-for-url-parameters) to encode characters in your control values (such as commas) to prevent the system from interpreting them as separators.\n\nFor example:\n\"New York, NY,Boston, MA\" can be encoded as:\n\n\"New%20York%2C%20NY,Boston%2C%20MA\"" timeout: type: number format: double tag: type: string description: Specifies the version tag of the workbook to be exported. exportAs: type: string description: Specifies the user ID of the Sigma user to run the export queries as, such as to enforce row-level security. Not supported for users who access Sigma with OAuth. rowLimit: type: number format: double description: 'Total number of rows to limit a CSV/XLSX/JSON-formatted export to. ' offset: type: number format: double description: 'The offset number of rows for a CSV/XLSX/JSON-formatted export to start from. ' required: - pageId - format description: Export a page of a workbook title: WorkbooksExportWorkbookRequest1 ? V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExportOneOf1ExportFormat : type: string enum: - csv - csv.gzip title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExportOneOf1ExportFormat ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type : type: string enum: - queryColumn title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf8Type : type: string enum: - date-range title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf8Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions6: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf6Type' required: - type title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions6 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf7Type : type: string enum: - boolean-list title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf7Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8 V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission: type: string enum: - view - explore - edit description: Permission to grant for access to the workbook. title: V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf3Type: type: string enum: - slackChannel title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf3Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf2Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables2 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf9Type: type: string enum: - number-range title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf9Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf7Type: type: string enum: - boolean-list title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf7Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables8: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf8Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables8 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems2' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2Formatting: type: object properties: pivotHeaderStyle: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2FormattingPivotHeaderStyle' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2Formatting V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DashboardSettingsFiltersItems: type: object properties: id: type: string filterStr: type: string required: - id - filterStr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DashboardSettingsFiltersItems ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf2Type' value: type: string required: - type - value description: Text value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value2 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type' nodeIds: type: array items: type: string required: - type - nodeIds description: Export multiple elements title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource2 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables11: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf11Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables11 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems2' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2AlertConfigWindow: type: string enum: - alltime - daily - weekly - always title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2AlertConfigWindow ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf2Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf2Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems1' title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type' sheetId: type: string mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value' required: - type - sheetId - mode - columnId - op title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems2 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2: type: object properties: title: type: string messageBody: type: string notificationAttachments: type: array items: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItems' includeLink: type: boolean runAsRecipient: type: boolean attachmentSettings: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AttachmentSettings' conditionOptions: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions' alertConfig: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AlertConfig' notificationName: type: string dashboardSettings: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DashboardSettings' dynamicExportSettings: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettings' dynamicRecipientSettings: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicRecipientSettings' rowLimit: type: number format: double workbookVariant: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2WorkbookVariant' embedOpts: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2EmbedOpts' formatting: oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2Formatting' - type: 'null' required: - title - messageBody - notificationAttachments title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf13Type: type: string enum: - boolean-null title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf13Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf0Type : type: string enum: - fixed-date title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2: type: object properties: title: type: string messageBody: type: string notificationAttachments: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItems' includeLink: type: boolean runAsRecipient: type: boolean attachmentSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2AttachmentSettings' conditionOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions' alertConfig: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2AlertConfig' notificationName: type: string dashboardSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DashboardSettings' dynamicExportSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettings' dynamicRecipientSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicRecipientSettings' rowLimit: type: number format: double workbookVariant: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2WorkbookVariant' embedOpts: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2EmbedOpts' formatting: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2Formatting' - type: 'null' required: - title - messageBody - notificationAttachments title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type' sheetId: type: string mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value' required: - type - sheetId - mode - columnId - op title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems2 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2AttachmentSettings: type: object properties: mergePdfAttachments: type: boolean zipAttachments: type: boolean title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2AttachmentSettings ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2AttachmentSettings: type: object properties: mergeAttachments: type: boolean description: Combines multiple PDF or XLSX attachments into a single file zipAttachments: type: boolean description: Send attachments as a .zip file description: Export attachment settings title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2AttachmentSettings V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf0Type: type: string enum: - boolean title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf2Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables9: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf9Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables9 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min2' description: Date selection title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItemsOneOf1Type' required: - type description: Null date value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type DashVariablesOneOf12Type: type: string enum: - text-null title: DashVariablesOneOf12Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables13 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf13Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables13 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3 DataTypesOneOf9Val0: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf9ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: DataTypesOneOf9Val0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf3Type: type: string enum: - date title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf3Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type DashVariablesOneOf8MinOneOf1Unit: type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second title: DashVariablesOneOf8MinOneOf1Unit ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1Type : type: string enum: - text-list title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1Type workbooks_createWorkbookGrant_Response_200: type: object properties: {} title: workbooks_createWorkbookGrant_Response_200 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems1 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems1 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItems: type: object properties: formatOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions' description: Export format options workbookExportSource: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource' description: Workbook export source options required: - formatOptions - workbookExportSource description: Export attachment title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItems DashVariables8: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf8Type' min: oneOf: - $ref: '#/components/schemas/DashVariablesOneOf8Min' - type: 'null' max: oneOf: - $ref: '#/components/schemas/DashVariablesOneOf8Max' - type: 'null' required: - type - min - max title: DashVariables8 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems2' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues63: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf3Type' required: - type description: Null boolean value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues63 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource3 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type' nodeIds: type: array items: type: string required: - type - nodeIds description: Export multiple pages title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6 DataTypesOneOf9ValOneOf4Type: type: string enum: - datetimeArr title: DataTypesOneOf9ValOneOf4Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables11 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf11Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables11 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaTargetItems: type: object properties: teamId: type: string description: Unique identifier of the team to export to email: type: string description: Email address to export to ccEmail: type: string description: Email address to add as a Cc recipient bccEmail: type: string description: Email address to add as a Bcc recipient ccTeamId: type: string description: Unique identifier of the team to add as a Cc recipient bccTeamId: type: string description: Unique identifier of the team to add as a Bcc recipient slackConversationId: type: string description: Slack channel ID or member ID to export to googleSpreadsheetUrl: type: string description: URL of the Google Sheet to export to googleDriveFolderUrl: type: string description: URL of the Google Drive folder to export to webhookUrl: type: string description: URL of the webhook endpoint to export to title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaTargetItems workbooks_updateWorkbookBookmark_Response_200: type: object properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. isDefault: type: boolean description: Whether the bookmark is default. required: - bookmarkId - name - isShared - exploreKey title: workbooks_updateWorkbookBookmark_Response_200 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf0Type: type: string enum: - member title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf0Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf1Type' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf1Value' required: - type - value description: Boolean list value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues1 workbooks_copyTaggedWorkbook_Response_200: type: object properties: workbookId: type: string description: Unique identifier of the workbook. workbookUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number format: double ownerId: type: string createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. isArchived: type: boolean tags: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdTagVersionTagCopyPostResponsesContentApplicationJsonSchemaTagsItems' description: type: string taggedSourceUrlId: type: string description: For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request. required: - workbookId - workbookUrlId - name - url - path - latestVersion - ownerId - createdBy - updatedBy - createdAt - updatedAt title: workbooks_copyTaggedWorkbook_Response_200 workbooks_restoreWorkbookVersion_Response_200: type: object properties: workbookId: type: string description: Unique identifier of the workbook. workbookUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number format: double ownerId: type: string createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. isArchived: type: boolean tags: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdRestoreVersionPostResponsesContentApplicationJsonSchemaTagsItems' description: type: string taggedSourceUrlId: type: string description: For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request. required: - workbookId - workbookUrlId - name - url - path - latestVersion - ownerId - createdBy - updatedBy - createdAt - updatedAt title: workbooks_restoreWorkbookVersion_Response_200 DataTypes8: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf8Type' val: type: string required: - type - val title: DataTypes8 DataTypesOneOf0Type: type: string enum: - 'null' title: DataTypesOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems2' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf4Layout : type: string enum: - portrait - landscape title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf4Layout V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf2Type' required: - type description: Null date value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max2 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2FormattingPivotHeaderStyle: type: string enum: - merged - repeated title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2FormattingPivotHeaderStyle V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf3Type' required: - type description: XLSX export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions5: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf5Type' required: - type description: PNG export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type : type: string enum: - JSONL title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type : type: string enum: - PDF title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf0Type : type: string enum: - boolean title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf0Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf1Type : type: string enum: - prior - next title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1 DataTypesOneOf9ValOneOf3Type: type: string enum: - stringArr title: DataTypesOneOf9ValOneOf3Type V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType1: type: string enum: - number title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues60: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf0Type' required: - type description: Null date value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues60 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type : type: string enum: - CSV title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItemsOneOf1Type : type: string enum: - text-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItemsOneOf1Type V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf1Type' connectionId: type: - string - 'null' name: type: - string - 'null' dataModelId: type: string required: - type - connectionId - name - dataModelId title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems1 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions1' description: Export condition options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type : type: string enum: - EXCEL title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5 V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: embedId: type: string description: Unique identifier of the embed. embedUrl: type: string public: type: boolean sourceType: $ref: '#/components/schemas/V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItemsSourceType' sourceId: type: - string - 'null' sourceName: type: - string - 'null' required: - embedId - embedUrl - public - sourceType - sourceId - sourceName title: V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItems workbooks_getWorkbook_Response_200: type: object properties: workbookId: type: string description: Unique identifier of the workbook. workbookUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number format: double ownerId: type: string createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. isArchived: type: boolean tags: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdGetResponsesContentApplicationJsonSchemaTagsItems' description: type: string taggedSourceUrlId: type: string description: For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request. required: - workbookId - workbookUrlId - name - url - path - latestVersion - ownerId - createdBy - updatedBy - createdAt - updatedAt title: workbooks_getWorkbook_Response_200 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Type' description: Type of condition elementId: type: string description: ID of the element columnId: type: string description: ID of the column op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Op' description: Operator mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Mode' description: Kind of condition evaluation value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value' description: Column value required: - type - elementId - columnId - op - mode description: If a condition is met title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition2 V2WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsSchedule: type: object properties: cronSpec: type: string description: Cron expression to use for the schedule timezone: type: string description: Timezone code, for example, PST title: V2WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsSchedule ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource2' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource3' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource4' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf1Type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - worksheet title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems5: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5Type' googleDriveFolderUrl: type: string required: - type - googleDriveFolderUrl title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems5 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables9: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf9Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables9 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type : type: string enum: - sheetColumn title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues63 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf3Type' required: - type description: Null boolean value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues63 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3Type' conditions: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItems' required: - type - conditions title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions3 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type' elementId: type: string required: - type - elementId description: Export one element title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource0 workbooks_listWorkbookSchedules_Response_200: oneOf: - $ref: '#/components/schemas/WorkbooksListWorkbookSchedulesResponse2000' - $ref: '#/components/schemas/WorkbooksListWorkbookSchedulesResponse2001' title: workbooks_listWorkbookSchedules_Response_200 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type' nodeIds: type: array items: type: string required: - type - nodeIds description: Export multiple elements title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf1Type : type: string enum: - JSONL title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions4 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type' layout: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout' scaleFactor: type: number format: double required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions4 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf1Type: type: string enum: - page title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf1Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf1Type' teamId: type: string required: - type - teamId title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems1 DashVariablesOneOf8Type: type: string enum: - date-range title: DashVariablesOneOf8Type V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormat1: type: object properties: pageSize: $ref: '#/components/schemas/V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormatOneOf1PageSize' description: Use a custom page size. unit: $ref: '#/components/schemas/V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormatOneOf1Unit' description: Unit for the `width` and `height` values. width: type: number format: double description: Page width, in the given unit. height: type: number format: double description: Page height, in the given unit. required: - pageSize - unit - width - height description: A custom page size, in pixels, inches, or centimeters. title: V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormat1 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5Type: type: string enum: - gdrive title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf5Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems2' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Type: type: string enum: - workbook title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Type workbooks_listWorkbookEmbeds_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItems' description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. total: type: number format: double description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' required: - entries - nextPage title: workbooks_listWorkbookEmbeds_Response_200 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2AlertConfig: type: object properties: window: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2AlertConfigWindow' volume: type: - number - 'null' format: double required: - window title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2AlertConfig ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf0Type : type: string enum: - boolean title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf0Type workbooks_listMaterializationSchedules_Response_200: oneOf: - $ref: '#/components/schemas/WorkbooksListMaterializationSchedulesResponse2000' - $ref: '#/components/schemas/WorkbooksListMaterializationSchedulesResponse2001' title: workbooks_listMaterializationSchedules_Response_200 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions6' description: Export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues6' description: Variable value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItemsOneOf1Type : type: string enum: - number-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItemsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1 DashVariablesOneOf3ValueOneOf1Type: type: string enum: - prior - next title: DashVariablesOneOf3ValueOneOf1Type V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems7: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf7Type' connectionId: type: - string - 'null' name: type: - string - 'null' worksheetId: type: string description: Unique identifier of the worksheet required: - type - connectionId - name - worksheetId title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems7 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type V2WorkbooksTagPostRequestBodyContentApplicationJsonSchemaSourceMappingConfigItemsPathsItems: type: object properties: fromPath: type: array items: type: string toPath: type: array items: type: string required: - fromPath - toPath title: V2WorkbooksTagPostRequestBodyContentApplicationJsonSchemaSourceMappingConfigItemsPathsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max2' description: Date selection title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues02: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf2Type' value: type: string required: - type - value description: Text value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues02 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf6Type: type: string enum: - date-list title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf6Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2: type: object properties: title: type: string messageBody: type: string notificationAttachments: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItems' includeLink: type: boolean runAsRecipient: type: boolean attachmentSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2AttachmentSettings' conditionOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions' alertConfig: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2AlertConfig' notificationName: type: string dashboardSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DashboardSettings' dynamicExportSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettings' dynamicRecipientSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicRecipientSettings' rowLimit: type: number format: double workbookVariant: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2WorkbookVariant' embedOpts: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2EmbedOpts' formatting: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2Formatting' - type: 'null' required: - title - messageBody - notificationAttachments title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions1' description: Export condition options title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables10 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf10Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables10 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf3Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables3 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value3' description: Column value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions0: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf0Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type workbooks_postWorkbookSchedule_Response_200: type: object properties: scheduledNotificationId: type: string description: Unique identifier of the scheduled export. workbookId: type: string description: Unique identifier of the workbook. schedule: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaSchedule' configV2: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2' isSuspended: type: boolean description: Whether the schedule is currently suspended. ownerId: type: string description: Unique identifier of the user who owns the schedule. lastUpdatedByUser: type: string description: Unique identifier of the user who last updated the schedule. disabledAt: type: - string - 'null' format: date-time description: Timestamp when the schedule was disabled, or null if the schedule is active. disabledBy: type: - string - 'null' description: Unique identifier of the member who disabled the schedule, or null if the schedule is active. createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. required: - scheduledNotificationId - workbookId - schedule - configV2 - isSuspended - ownerId - lastUpdatedByUser - disabledAt - disabledBy - createdBy - updatedBy - createdAt - updatedAt title: workbooks_postWorkbookSchedule_Response_200 V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems7' title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems2' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions5: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf5Type' required: - type description: PNG export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions5 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type : type: string enum: - JSON title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions3 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions3 V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType7: type: string enum: - boolean-list title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType7 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2AttachmentSettings: type: object properties: mergePdfAttachments: type: boolean zipAttachments: type: boolean title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2AttachmentSettings ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables11: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf11Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables11 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6 V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf4Type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - worksheet title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf4Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItemsOneOf1Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItemsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf0Type: type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettings: type: object properties: variables: type: object additionalProperties: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettings V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2WorkbookVariant: type: object properties: tagId: type: string exploreKey: type: string bookmarkId: type: string title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2WorkbookVariant ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type WorkbooksListMaterializationSchedulesResponse2000: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaOneOf0EntriesItems' required: - entries title: WorkbooksListMaterializationSchedulesResponse2000 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type V2WorkbooksWorkbookIdBookmarksGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. isDefault: type: boolean description: Whether the bookmark is default. required: - bookmarkId - name - isShared - exploreKey title: V2WorkbooksWorkbookIdBookmarksGetResponsesContentApplicationJsonSchemaEntriesItems V2WorkbooksWorkbookIdEmbedsPostRequestBodyContentApplicationJsonSchemaEmbedType: type: string enum: - public description: Defines the visibility and access control of the embed. Choose `public` for open access. title: V2WorkbooksWorkbookIdEmbedsPostRequestBodyContentApplicationJsonSchemaEmbedType V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicRecipientSettings: type: object properties: sourceNodeId: type: string recipientColumnId: type: string required: - sourceNodeId - recipientColumnId title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicRecipientSettings ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type' elementId: type: string required: - type - elementId description: Export one element title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource0 workbooks_getWorkbookSchema_Response_200: type: object properties: workbookId: type: string description: Unique identifier of the workbook. workbookUrlId: type: string pages: type: object additionalProperties: description: Any type sheets: type: object additionalProperties: description: Any type variables: type: object additionalProperties: description: Any type elements: type: object additionalProperties: description: Any type sqlQueries: type: object additionalProperties: type: string sqlQueryErrors: type: object additionalProperties: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchemaGetResponsesContentApplicationJsonSchemaSqlQueryErrors' required: - workbookId - workbookUrlId - pages - sheets - variables - elements - sqlQueries - sqlQueryErrors title: workbooks_getWorkbookSchema_Response_200 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1Type' conditions: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems' required: - type - conditions title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type' sheetId: type: string required: - type - sheetId title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions2 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems2 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type' tileId: type: string mode: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value' required: - type - tileId - mode - columnId - op title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues22: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2Type' value: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems' required: - type - value description: Date list value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues22 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value2' description: Date selection title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf5Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type' required: - type description: Export all pages and elements in a workbook title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource4 DashVariables17: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf17Type' value: type: array items: $ref: '#/components/schemas/DashVariablesOneOf17ValueItems' required: - type - value title: DashVariables17 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type' required: - type description: Export all pages and elements in a workbook title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource4 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5 V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItemsSourceType: type: string enum: - workbook - page - element title: V2WorkbooksWorkbookIdEmbedsGetResponsesContentApplicationJsonSchemaEntriesItemsSourceType ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DashboardSettingsFiltersItems: type: object properties: id: type: string filterStr: type: string required: - id - filterStr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DashboardSettingsFiltersItems V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2AlertConfig: type: object properties: window: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2AlertConfigWindow' volume: type: - number - 'null' format: double required: - window title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2AlertConfig V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0Format0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0FormatOneOf0Type' required: - type description: Export options for csv, json, jsonl, xlsx title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0Format0 V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItemsOneOf1Type: type: string enum: - dataset description: Dataset (deprecated) title: V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItemsOneOf1Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicRecipientSettings: type: object properties: sourceNodeId: type: string recipientColumnId: type: string required: - sourceNodeId - recipientColumnId title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicRecipientSettings ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf5Type : type: string enum: - PNG title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf5Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables12 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf12Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables12 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues21: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1Type' value: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems' required: - type - value description: Text list value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues21 DataTypesOneOf5Type: type: string enum: - datetime title: DataTypesOneOf5Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems6: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6Type' cloudExport: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExport' required: - type - cloudExport title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems6 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItemsOneOf1Type : type: string enum: - number-null title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItemsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf8Type: type: string enum: - date-range title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf8Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions6' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2AlertConfigWindow: type: string enum: - alltime - daily - weekly - always title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2AlertConfigWindow V2WorkbooksWorkbookIdPagesGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: pageId: type: string description: Unique identifier of the workbook page. name: type: string hidden: type: boolean required: - pageId title: V2WorkbooksWorkbookIdPagesGetResponsesContentApplicationJsonSchemaEntriesItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type : type: string enum: - element title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions4: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf4Type' layout: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf4Layout' required: - type description: PDF export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions4 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3ValueItemsItems : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3ValueItemsItemsType' value: type: string required: - type - value description: Text value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3ValueItemsItems workbooks_deleteMaterializationSchedule_Response_200: type: object properties: {} title: workbooks_deleteMaterializationSchedule_Response_200 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions1: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1Type' conditions: type: array items: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems' required: - type - conditions title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions1 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues2: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues20' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues21' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues22' description: List value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues2 V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1Format: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1Format0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1Format1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1Format2' title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1Format V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf0Type' required: - type description: CSV export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf6Type : type: string enum: - date-list title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf6Type V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1FormatOneOf1Type: type: string enum: - png title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1FormatOneOf1Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems0 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf1Type' required: - type description: JSONL export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf13Type : type: string enum: - boolean-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf13Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf1Unit : type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf1Unit ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf3Type : type: string enum: - XLSX title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf6Type : type: string enum: - date-list title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf6Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf3Type : type: string enum: - fixed-date title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems1 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions6: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf6Type' required: - type description: No export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions6 workbooks_deleteWorkbookEmbeds_Response_200: type: object properties: {} title: workbooks_deleteWorkbookEmbeds_Response_200 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type' pageId: type: string required: - type - pageId description: Export one page title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type : type: string enum: - JSON title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type V2WorkbooksWorkbookIdVersionHistoryGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: version: type: number format: double publishedAt: type: string format: date-time publishedBy: type: string tags: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdVersionHistoryGetResponsesContentApplicationJsonSchemaEntriesItemsTagsItems' required: - version - publishedAt - publishedBy title: V2WorkbooksWorkbookIdVersionHistoryGetResponsesContentApplicationJsonSchemaEntriesItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type DashVariablesOneOf8MaxOneOf0Type: type: string enum: - fixed title: DashVariablesOneOf8MaxOneOf0Type DataTypes1: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf1Type' val: type: boolean description: Set data value required: - type - val title: DataTypes1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf0Type' elementIds: type: array items: type: string description: Array of element identifiers to export required: - type - elementIds description: Export multiple elements title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource0 workbooks_getWorkbookColumns_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_getWorkbookColumns_Response_200 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource4' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7 DashVariablesOneOf11Type: type: string enum: - number-null title: DashVariablesOneOf11Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables4: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf4Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables4 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables4: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf4Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables4 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf2Type : type: string enum: - JSON title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItems2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type' sheetId: type: string mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value' required: - type - sheetId - mode - columnId - op title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItems2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type workbooks_v2_1_listMaterializationSchedules_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V21WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaEntriesItems' description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. total: type: number format: double description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' required: - entries - nextPage title: workbooks_v2_1_listMaterializationSchedules_Response_200 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf1Type: type: string enum: - boolean-list title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf1Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf0Type : type: string enum: - fixed-date title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf0Type' userId: type: string required: - type - userId title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems0 V2WorkbooksPostResponsesContentApplicationJsonSchemaTagsItems: type: object properties: versionTagId: type: string description: Unique identifier of the tag. name: type: string sourceWorkbookVersion: type: number format: double taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. workbookTaggedAt: type: string format: date-time required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt title: V2WorkbooksPostResponsesContentApplicationJsonSchemaTagsItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1 DashVariables1: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf1Type' value: type: - number - 'null' format: double required: - type - value title: DashVariables1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type : type: string enum: - page title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type' tileId: type: string required: - type - tileId title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems1 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf2Type: type: string enum: - sheetColumn title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type : type: string enum: - page title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type : type: string enum: - sheetColumn title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions2 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions2 V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems4: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf4Type' connectionId: type: - string - 'null' name: type: - string - 'null' csvId: type: string description: Unique identifier of the uploaded CSV file required: - type - connectionId - name - csvId title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems4 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems1' title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf7Type : type: string enum: - boolean-list title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf7Type V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsSchedule: type: object properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. required: - cronSpec - timezone title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsSchedule ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables13: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf13Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables13 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type : type: string enum: - JSONL title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type : type: string enum: - chartColumn title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItemsOneOf0Type' value: type: number format: double required: - type - value description: Number value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems0 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3Type: type: string enum: - dashboard title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf0Type' sourceIds: type: - array - 'null' items: type: string description: List of direct sources for the element. Either element IDs or data source IDs. elementId: type: string description: Unique identifier of the element dataSourceIds: type: - array - 'null' items: type: string description: List of root sources for the element as data source IDs. required: - type - sourceIds - elementId - dataSourceIds title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems0 DashVariablesOneOf9Type: type: string enum: - number-range title: DashVariablesOneOf9Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItems2' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItems V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf0Type: type: string enum: - always title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf0Type V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AttachmentSettings: type: object properties: mergePdfAttachments: type: boolean zipAttachments: type: boolean title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AttachmentSettings ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaSchedule: type: object properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. required: - cronSpec - timezone title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaSchedule ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DashboardSettings: type: object properties: filters: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DashboardSettingsFiltersItems' variableValues: $ref: '#/components/schemas/DashVariables_2' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DashboardSettings ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems0 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type' sheetId: type: string required: - type - sheetId title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2AttachmentSettings: type: object properties: mergeAttachments: type: boolean description: Combines multiple PDF or XLSX attachments into a single file zipAttachments: type: boolean description: Send attachments as a .zip file description: Export attachment settings title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2AttachmentSettings V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AttachmentSettings: type: object properties: mergePdfAttachments: type: boolean zipAttachments: type: boolean title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AttachmentSettings DashVariables13: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf13Type' required: - type title: DashVariables13 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItems: type: object properties: formatOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions' description: Export format options workbookExportSource: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource' description: Workbook export source options required: - formatOptions - workbookExportSource description: Export attachment title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf11Type : type: string enum: - number-null title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf11Type V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItemsOneOf0Type: type: string enum: - data-model title: V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItemsOneOf0Type workbooks_listWorkbooks_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksGetResponsesContentApplicationJsonSchemaEntriesItems' description: Array of results returned by the endpoint nextPage: type: - string - 'null' description: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`. total: type: number format: double description: Total number of results. Useful to determine if there is a need to paginate. hasMore: type: boolean description: '**[Deprecated]** Indicates whether more results are available.' required: - entries - nextPage title: workbooks_listWorkbooks_Response_200 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2FormattingPivotHeaderStyle: type: string enum: - merged - repeated title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2FormattingPivotHeaderStyle V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf2Type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - worksheet title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues60 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf0Type' required: - type description: Null date value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues60 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables9' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables10' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables11' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables12' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables13' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type : type: string enum: - page title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItemsOneOf0Type' value: type: number format: double required: - type - value description: Number value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf2Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf2Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2WorkbookVariant: type: object properties: tagId: type: string exploreKey: type: string bookmarkId: type: string title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2WorkbookVariant ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItemsOneOf0Type' date: type: string description: ISO-8601 date string required: - type - date description: Fixed date selection title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems0 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables7: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf7Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables7 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions6 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type : type: string enum: - JSON title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf3Type' nodeIds: type: array items: type: string required: - type - nodeIds description: Export multiple pages title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource3 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AlertConfig: type: object properties: window: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AlertConfigWindow' volume: type: - number - 'null' format: double required: - window title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AlertConfig ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf2Type' required: - type description: Null date value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type' layout: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout' scaleFactor: type: number format: double required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions4 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf1Unit : type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf1Unit V2WorkbooksWorkbookIdEmbedsPostRequestBodyContentApplicationJsonSchemaSourceType: type: string enum: - workbook - page - element description: 'Specifies the scope of the embed: "workbook" for the entire workbook, "page" for a single page, or "element" for a specific element within the workbook.' title: V2WorkbooksWorkbookIdEmbedsPostRequestBodyContentApplicationJsonSchemaSourceType ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type V2WorkbooksWorkbookIdCopyPostResponsesContentApplicationJsonSchemaTagsItems: type: object properties: versionTagId: type: string description: Unique identifier of the tag. name: type: string sourceWorkbookVersion: type: number format: double taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. workbookTaggedAt: type: string format: date-time required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt title: V2WorkbooksWorkbookIdCopyPostResponsesContentApplicationJsonSchemaTagsItems DashVariablesOneOf7Value: type: object properties: 'true': type: boolean 'false': type: boolean 'null': type: boolean required: - 'true' - 'false' title: DashVariablesOneOf7Value ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type : type: string enum: - JSONL title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItems2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type' tileId: type: string mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value' required: - type - tileId - mode - columnId - op title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItems2 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems8: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8Type' workbookCloudExport: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExport' required: - type - workbookCloudExport title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems8 V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormatOneOf0PageSize: type: string enum: - letter - a4 - legal - a3 description: A standard page-size preset. title: V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormatOneOf0PageSize V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItemsColumnMappingItemsFromColumn: oneOf: - type: string - type: array items: type: string title: V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItemsColumnMappingItemsFromColumn ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems2' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems DataTypesOneOf9ValOneOf0Type: type: string enum: - boolArr title: DataTypesOneOf9ValOneOf0Type workbooks_getWorkbookMaterialization_Response_200: type: object properties: materializationId: type: string status: type: string startedAt: type: string format: date-time readyAt: type: string format: date-time expiredAt: type: string format: date-time error: type: string required: - materializationId - status title: workbooks_getWorkbookMaterialization_Response_200 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf1Type' unit: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf1Unit' x: type: number format: double required: - type - unit - x description: Relative date selection, for example "Next 4 days" title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf1Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type DashVariablesOneOf8Max1: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf8MaxOneOf1Type' unit: $ref: '#/components/schemas/DashVariablesOneOf8MaxOneOf1Unit' x: type: number format: double required: - type - unit - x title: DashVariablesOneOf8Max1 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2AlertConfigWindow: type: string enum: - alltime - daily - weekly - always title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2AlertConfigWindow V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables9' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables10' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables11' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables12' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables13' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf1Type' required: - type description: JSONL export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions1 workbooks_deleteWorkbookBookmarks_Response_200: type: object properties: {} title: workbooks_deleteWorkbookBookmarks_Response_200 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf2Type: type: string enum: - email title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems1' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems DashVariablesOneOf3Value1: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf3ValueOneOf1Type' unit: $ref: '#/components/schemas/DashVariablesOneOf3ValueOneOf1Unit' x: type: number format: double required: - type - unit - x title: DashVariablesOneOf3Value1 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions6: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf6Type' required: - type description: No export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions6 V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaWarningsItemsDetailsItemsParent: type: object properties: type: type: string description: Unsupported parent type, in kebab-case (e.g. `sidebar-panel`, `repeater`, `modal`). id: type: string description: ID of the unsupported parent in the source workbook. required: - type - id description: The unsupported parent that caused this element to drop, if applicable. title: V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaWarningsItemsDetailsItemsParent ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItemsOneOf0Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type : type: string enum: - CSV title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Type' conditions: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems' required: - type - conditions title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions1 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItems2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf2Type' elementId: type: string columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf2Op' description: Operator mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf2Mode' description: Check condition value: oneOf: - $ref: '#/components/schemas/DataTypes_2' - type: 'null' description: Data value required: - type - elementId - columnId - op - mode title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItems2 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions3' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItems0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf0Type' elementId: type: string required: - type - elementId title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItems0 V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0FormatOneOf1Layout: type: string enum: - portrait - landscape title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0FormatOneOf1Layout V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues01: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf1Type' value: type: number format: double required: - type - value description: Number value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues01 DashVariablesOneOf0Type: type: string enum: - boolean title: DashVariablesOneOf0Type V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType9' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType10' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType11' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType12' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType13' description: Value of the control title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExportOneOf0ConnectionType : type: string enum: - snowflake - redshift title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExportOneOf0ConnectionType ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf0Type : type: string enum: - fixed-date title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min2' description: Date selection title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2Type' conditions: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItems' required: - type - conditions title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions2 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf3Type' required: - type description: XLSX export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type : type: string enum: - PNG title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies3: type: object properties: nodeId: type: string type: type: string name: type: string semanticViewTable: type: string required: - nodeId - type - name - semanticViewTable title: V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies3 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type : type: string enum: - PDF title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type' tileId: type: string required: - type - tileId title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItems0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf6Type : type: string enum: - NONE title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf6Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf10Type : type: string enum: - date-null title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf10Type V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItemsOneOf2Type' inodeId: type: string required: - type - inodeId title: V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsSchedule: type: object properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. required: - cronSpec - timezone title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsSchedule ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItemsOneOf0Type' value: type: string required: - type - value description: Text value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems0 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2Type: type: string enum: - worksheet title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout : type: string enum: - portrait - landscape title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2 V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: name: type: string valueType: $ref: '#/components/schemas/V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType' description: Value of the control required: - name - valueType title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItems ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5 V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType0: type: string enum: - boolean title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf2Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2Type' conditions: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems' required: - type - conditions title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems0 V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies1: type: object properties: nodeId: type: string type: type: string name: type: string elementId: type: string required: - nodeId - type - name - elementId title: V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies1 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1Type' conditions: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItems' required: - type - conditions title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1 V2WorkbooksWorkbookIdTagsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: versionTagId: type: string description: Unique identifier of the tag. name: type: string sourceWorkbookVersion: type: number format: double taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. workbookTaggedAt: type: string format: date-time required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt title: V2WorkbooksWorkbookIdTagsGetResponsesContentApplicationJsonSchemaEntriesItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type : type: string enum: - NONE title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf2Type' required: - type description: Export all content title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource2 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions: oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions2' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions3' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConfig: type: object properties: title: type: string messageBody: type: string includeLink: type: boolean runAsRecipient: type: boolean rowLimit: type: number format: double required: - title - messageBody title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConfig V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables10: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf10Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables10 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2Formatting: type: object properties: pivotHeaderStyle: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2FormattingPivotHeaderStyle' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2Formatting V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables1 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3Type' conditions: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems' required: - type - conditions title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions3 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Type' condition: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition' required: - type - condition description: Send the export based on a condition title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions1 DashVariables10: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf10Type' required: - type title: DashVariables10 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf2Type' required: - type description: JSON export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type : type: string enum: - page title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type' elementId: type: string required: - type - elementId description: Export one element title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf3Type : type: string enum: - date title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type : type: string enum: - queryColumn title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type DataTypesOneOf9ValOneOf5Type: type: string enum: - bytesArr title: DataTypesOneOf9ValOneOf5Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExport1: type: object properties: connectionType: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExportOneOf1ConnectionType' uri: type: string exportFormat: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExportOneOf1ExportFormat' timestampedUri: type: - string - 'null' required: - connectionType - uri - exportFormat - timestampedUri title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf8WorkbookCloudExport1 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems2' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf2Type : type: string enum: - text title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf0Type: type: string enum: - always title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf0Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf0Type: type: string enum: - always title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf2Type : type: string enum: - text title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf2Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf2Type : type: string enum: - text title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues01 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf1Type' value: type: number format: double required: - type - value description: Number value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues01 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0 V2WorkbooksWorkbookIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType: type: object properties: {} description: The column's data type, represented as a recursive type object. title: V2WorkbooksWorkbookIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType DashVariables16: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf16Type' required: - type title: DashVariables16 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables10: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf10Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables10 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf13Type : type: string enum: - boolean-null title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf13Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type' required: - type description: Export all pages and elements in a workbook title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource4 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf1Type: type: string enum: - JSON title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type WorkbooksExportWorkbookRequest0: type: object properties: elementId: type: string format: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0Format' parameters: type: object additionalProperties: type: string description: "Specify the control ID and control value of one or more control elements in the workbook or report to filter the returned data. The control must exist in the Sigma workbook or report and target an element before you can export based on the control value.\n\n**Syntax**\n{ control-id: control-value }\n\nThe control-id is configured in the Sigma workbook or report. The control-value is the value that is passed to the control.\n\nValues can take multiple forms, depending on the data type of the control:\n\n**Boolean**\n\n- Single value: \"true\" | \"false\" | \":null\"\n- List of Boolean: \"true,false,:null\" (No space after the comma.)\n\n**Number**\n\n- Single value: \"10.54\", \":null\"\n- List of values: \"10.54,23.45,:null\" (No space after the comma.)\n- Range of numbers: \"min:10.54,max:23.45\" (No space after the comma or colon.)\n\n**Text**\n\n- Single value: \"some-text\" | \":null\" | \":empty\"\n- List of values: \"some-text,more-text,:null,:empty\" (No space after the comma.)\n\n**Date**\n\nAll dates use UTC time zones.\n\n- Fixed date using ISO-6801 format: \"2022-01-01T01:01:59\" | \":null\"\n - Formats supported (where: %Y: year, %m: month, %d: day, %H:hours, %M: minutes, %S: seconds):\n - %Y-%m-%d\n - %Y-%m-%dT%H:%M\n - %Y-%m-%dT%H:%M:%S\n- List of fixed dates: \"2022-01-01T01:01:59,2022-02-02T02:02:59,:null\"\n- Relative date: \"prior-day-3\" | \"next-day-3\"\n - Format: [prior|next]-[year|quarter|month|week|isoWeek|day|hour|minute]-[number]\n- Date range: \"min:2022-01-01T01:01:59,max:next-day-3\" (No spaces after the comma or colon.)\n - Leave max blank for \"on or after\" and min blank for \"on or before\", for example:\n - \"Date-Range\": \"min:2020-04-01,max:\"\n - \"Date-Range\": \"min:,max:next-day-3\"\n\n**Notes**\n\n- \":null\" is a special value that denotes the null primitive value.\n- \":empty\" is a special value that denotes the empty string \"\".\n\nUse [URL encoding](https://help.sigmacomputing.com/docs/special-characters-for-url-parameters) to encode characters in your control values (such as commas) to prevent the system from interpreting them as separators.\n\nFor example:\n\"New York, NY,Boston, MA\" can be encoded as:\n\n\"New%20York%2C%20NY,Boston%2C%20MA\"" timeout: type: number format: double tag: type: string description: Specifies the version tag of the workbook to be exported. exportAs: type: string description: Specifies the user ID of the Sigma user to run the export queries as, such as to enforce row-level security. Not supported for users who access Sigma with OAuth. rowLimit: type: number format: double description: 'Total number of rows to limit a CSV/XLSX/JSON-formatted export to. ' offset: type: number format: double description: 'The offset number of rows for a CSV/XLSX/JSON-formatted export to start from. ' required: - elementId - format description: Export a specific element title: WorkbooksExportWorkbookRequest0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf0Type' value: type: boolean required: - type - value description: Boolean value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf0Type' required: - type description: Always send the export title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions0 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfig: type: object properties: formatOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptions' description: Export format options title: type: string description: Title of the message messageBody: type: string description: Body of the message includeLink: type: boolean description: Whether to include a link to the exported folder or document in the body of the message runAsRecipient: type: boolean description: Whether to run the export as if it were being run by the recipient rowLimit: type: number format: double description: Maximum number of rows to export chartId: type: string description: Identifier of the chart to export parameters: type: object additionalProperties: type: string description: "Specify the control ID and control value of one or more control elements in the workbook or report to filter the returned data. The control must exist in the Sigma workbook or report and target an element before you can export based on the control value.\n\n**Syntax**\n{ control-id: control-value }\n\nThe control-id is configured in the Sigma workbook or report. The control-value is the value that is passed to the control.\n\nValues can take multiple forms, depending on the data type of the control:\n\n**Boolean**\n\n- Single value: \"true\" | \"false\" | \":null\"\n- List of Boolean: \"true,false,:null\" (No space after the comma.)\n\n**Number**\n\n- Single value: \"10.54\", \":null\"\n- List of values: \"10.54,23.45,:null\" (No space after the comma.)\n- Range of numbers: \"min:10.54,max:23.45\" (No space after the comma or colon.)\n\n**Text**\n\n- Single value: \"some-text\" | \":null\" | \":empty\"\n- List of values: \"some-text,more-text,:null,:empty\" (No space after the comma.)\n\n**Date**\n\nAll dates use UTC time zones.\n\n- Fixed date using ISO-6801 format: \"2022-01-01T01:01:59\" | \":null\"\n - Formats supported (where: %Y: year, %m: month, %d: day, %H:hours, %M: minutes, %S: seconds):\n - %Y-%m-%d\n - %Y-%m-%dT%H:%M\n - %Y-%m-%dT%H:%M:%S\n- List of fixed dates: \"2022-01-01T01:01:59,2022-02-02T02:02:59,:null\"\n- Relative date: \"prior-day-3\" | \"next-day-3\"\n - Format: [prior|next]-[year|quarter|month|week|isoWeek|day|hour|minute]-[number]\n- Date range: \"min:2022-01-01T01:01:59,max:next-day-3\" (No spaces after the comma or colon.)\n - Leave max blank for \"on or after\" and min blank for \"on or before\", for example:\n - \"Date-Range\": \"min:2020-04-01,max:\"\n - \"Date-Range\": \"min:,max:next-day-3\"\n\n**Notes**\n\n- \":null\" is a special value that denotes the null primitive value.\n- \":empty\" is a special value that denotes the empty string \"\".\n\nUse [URL encoding](https://help.sigmacomputing.com/docs/special-characters-for-url-parameters) to encode characters in your control values (such as commas) to prevent the system from interpreting them as separators.\n\nFor example:\n\"New York, NY,Boston, MA\" can be encoded as:\n\n\"New%20York%2C%20NY,Boston%2C%20MA\"" required: - formatOptions - title - messageBody description: '**[Deprecated]** Configuration settings for the export.' title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfig V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf2Type: type: string enum: - JSON title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0 V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1' title: V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions3 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf0Type: type: string enum: - always title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf5Type : type: string enum: - number-range title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf5Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type V2WorkbooksWorkbookIdCopyPostRequestBodyContentApplicationJsonSchemaCopyBookmarks: type: string enum: - all - accessible description: If set to `all` (available to admins only), every saved view (bookmark) applied to the workbook is copied. If set to `accessible`, only personal saved views and those shared with the user initiating the operation are copied. Ownership of all saved views in the duplicate workbook transfers to the user initiating the operation. If not set, saved views are not copied. title: V2WorkbooksWorkbookIdCopyPostRequestBodyContentApplicationJsonSchemaCopyBookmarks V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf1Type' description: Type of condition elementId: type: string description: ID of the element required: - type - elementId description: If there's data title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition1 DataTypesOneOf1Type: type: string enum: - bool title: DataTypesOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type' tileId: type: string mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value' required: - type - tileId - mode - columnId - op title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems2 DataTypes6: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf6Type' val: type: string description: Set data value required: - type - val title: DataTypes6 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Mode: type: string enum: - any - all description: Kind of condition evaluation title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Mode ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues03 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Type' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value' description: Date selection required: - type - value description: Date value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues03 workbooks_createMaterializationSchedule_Response_201: type: object properties: sheetId: type: string description: Identifier of the materialization schedule for the element elementId: type: string description: Identifier of the element being materialized elementName: type: string schedule: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdElementsElementIdMaterializationSchedulesPostResponsesContentApplicationJsonSchemaSchedule' - type: 'null' configuredAt: type: string format: date-time paused: type: boolean required: - sheetId - elementId - elementName - schedule - configuredAt - paused title: workbooks_createMaterializationSchedule_Response_201 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf1Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf1Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables8: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf8Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables8 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaSuspensionAction: type: string enum: - pause - resume description: Action to take on the schedule. Use `pause` to pause the schedule and `resume` to resume the schedule. title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaSuspensionAction ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type : type: string enum: - EXCEL title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type workbooks_getElementColumns_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_getElementColumns_Response_200 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaSchedule: type: object properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. required: - cronSpec - timezone description: When to send the workbook export. title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaSchedule ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables12 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf12Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables12 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf6Type: type: string enum: - NONE title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf6Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type : type: string enum: - element title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNull - IsNotNull - Contains - StartsWith - EndsWith description: Operator title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Op ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf11Type : type: string enum: - number-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf11Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type' tileId: type: string required: - type - tileId title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems1 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf1Type' unit: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf1Unit' x: type: number format: double required: - type - unit - x description: Relative date selection, for example "Next 4 days" title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues62 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf2Type' required: - type description: Null text value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues62 DataTypesOneOf9Type: type: string enum: - array title: DataTypesOneOf9Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItems1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf1Type' elementId: type: string required: - type - elementId title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItems1 V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf5Type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - worksheet title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf5Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables5: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf5Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables5 DashVariables12: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf12Type' required: - type title: DashVariables12 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource4' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues61 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf1Type' required: - type description: Null number value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues61 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf1Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type : type: string enum: - page title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf11Type : type: string enum: - number-null title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf11Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type' pageId: type: string required: - type - pageId description: Export one page title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value3' description: Column value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource2 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type' nodeIds: type: array items: type: string required: - type - nodeIds description: Export multiple elements title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3Type : type: string enum: - hierarchical-list title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItemsOneOf0Type' value: type: string required: - type - value description: Text value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf2Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf2Type V2WorkbooksWorkbookIdTagVersionTagCopyPostResponsesContentApplicationJsonSchemaTagsItems: type: object properties: versionTagId: type: string description: Unique identifier of the tag. name: type: string sourceWorkbookVersion: type: number format: double taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. workbookTaggedAt: type: string format: date-time required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt title: V2WorkbooksWorkbookIdTagVersionTagCopyPostResponsesContentApplicationJsonSchemaTagsItems V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems6: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf6Type' connectionId: type: - string - 'null' name: type: - string - 'null' sqlDocumentId: type: string required: - type - connectionId - name - sqlDocumentId title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems6 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type : type: string enum: - PDF title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf9Type : type: string enum: - number-range title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf9Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf8Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables8 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2EmbedOpts: type: object properties: embedId: type: string evalConnectionId: type: string title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2EmbedOpts ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0 DashVariablesOneOf8MinOneOf1Type: type: string enum: - prior - next title: DashVariablesOneOf8MinOneOf1Type DashVariablesOneOf8Max0: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf8MaxOneOf0Type' date: type: number format: double required: - type - date title: DashVariablesOneOf8Max0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6 V2WorkbooksGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: workbookId: type: string description: Unique identifier of the workbook. workbookUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number format: double ownerId: type: string createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. isArchived: type: boolean tags: type: array items: $ref: '#/components/schemas/V2WorkbooksGetResponsesContentApplicationJsonSchemaEntriesItemsTagsItems' description: type: string taggedSourceUrlId: type: string description: For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request. required: - workbookId - workbookUrlId - name - url - path - latestVersion - ownerId - createdBy - updatedBy - createdAt - updatedAt title: V2WorkbooksGetResponsesContentApplicationJsonSchemaEntriesItems V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: scheduledNotificationId: type: string description: Unique identifier of the scheduled export. workbookId: type: string description: Unique identifier of the workbook. schedule: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsSchedule' configV2: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2' isSuspended: type: boolean description: Whether the schedule is currently suspended. ownerId: type: string description: Unique identifier of the user who owns the schedule. lastUpdatedByUser: type: string description: Unique identifier of the user who last updated the schedule. disabledAt: type: - string - 'null' format: date-time description: Timestamp when the schedule was disabled, or null if the schedule is active. disabledBy: type: - string - 'null' description: Unique identifier of the member who disabled the schedule, or null if the schedule is active. createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. required: - scheduledNotificationId - workbookId - schedule - configV2 - isSuspended - ownerId - lastUpdatedByUser - disabledAt - disabledBy - createdBy - updatedBy - createdAt - updatedAt title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItems DashVariablesOneOf4Type: type: string enum: - number-list title: DashVariablesOneOf4Type DashVariablesOneOf3Type: type: string enum: - date title: DashVariablesOneOf3Type V2WorkbooksTagPostRequestBodyContentApplicationJsonSchemaDataModelSourceTaggedVersionsItems: type: object properties: dataModelId: type: string fromVersionTagId: type: - string - 'null' toVersionTagId: type: - string - 'null' required: - dataModelId - fromVersionTagId - toVersionTagId title: V2WorkbooksTagPostRequestBodyContentApplicationJsonSchemaDataModelSourceTaggedVersionsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf10Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf10Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues21 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1Type' value: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems' required: - type - value description: Text list value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues21 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type : type: string enum: - queryColumn title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type DashVariables6: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf6Type' value: type: array items: type: - number - 'null' format: double required: - type - value title: DashVariables6 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems1' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf2Type : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf3Type' date: type: string description: ISO-8601 date string required: - type - date description: Fixed date selection title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value3 V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf3Type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - worksheet title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf3Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItems: type: object properties: formatOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions' chartId: type: string workbookExportSource: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource' required: - formatOptions title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource4' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf0Type : type: string enum: - boolean title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems0 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type' tileId: type: string required: - type - tileId title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf12Type : type: string enum: - text-null title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf12Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables9' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables10' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables11' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables12' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables13' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf4Type: type: string enum: - PDF title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf4Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf12Type : type: string enum: - text-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf12Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf1Type' unit: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf1Unit' x: type: number format: double required: - type - unit - x description: Relative date selection, for example "Next 4 days" title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min1 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2FormattingPivotHeaderStyle: type: string enum: - merged - repeated title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2FormattingPivotHeaderStyle DashVariablesOneOf10Type: type: string enum: - date-null title: DashVariablesOneOf10Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables6: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf6Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables6 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8 V2WorkbooksWorkbookIdTagsTagNameBookmarksGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. isDefault: type: boolean description: Whether the bookmark is default. required: - bookmarkId - name - isShared - exploreKey title: V2WorkbooksWorkbookIdTagsTagNameBookmarksGetResponsesContentApplicationJsonSchemaEntriesItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Type: type: string enum: - date-range title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Type workbooks_updateWorkbookSchedule_Response_200: type: object properties: scheduledNotificationId: type: string description: Unique identifier of the scheduled export. workbookId: type: string description: Unique identifier of the workbook. schedule: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaSchedule' configV2: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2' isSuspended: type: boolean description: Whether the schedule is currently suspended. ownerId: type: string description: Unique identifier of the user who owns the schedule. lastUpdatedByUser: type: string description: Unique identifier of the user who last updated the schedule. disabledAt: type: - string - 'null' format: date-time description: Timestamp when the schedule was disabled, or null if the schedule is active. disabledBy: type: - string - 'null' description: Unique identifier of the member who disabled the schedule, or null if the schedule is active. createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. required: - scheduledNotificationId - workbookId - schedule - configV2 - isSuspended - ownerId - lastUpdatedByUser - disabledAt - disabledBy - createdBy - updatedBy - createdAt - updatedAt title: workbooks_updateWorkbookSchedule_Response_200 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItemsOneOf1Type : type: string enum: - text-null title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItemsOneOf1Type workbooks_exportWorkbook_Request: oneOf: - $ref: '#/components/schemas/WorkbooksExportWorkbookRequest0' - $ref: '#/components/schemas/WorkbooksExportWorkbookRequest1' - $ref: '#/components/schemas/WorkbooksExportWorkbookRequest2' title: workbooks_exportWorkbook_Request V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2Format0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2FormatOneOf0Type' layout: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2FormatOneOf0Layout' required: - type - layout description: Export options for PDF documents title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2Format0 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions5: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type' pixelWidth: type: - number - 'null' format: double pixelHeight: type: - number - 'null' format: double required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions5 DataTypes7: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf7Type' val: type: object additionalProperties: $ref: '#/components/schemas/DataTypes_2' description: Set data value required: - type - val title: DataTypes7 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7 V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0FormatOneOf2Type: type: string enum: - png title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0FormatOneOf2Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max2' description: Date selection title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max workbooks_deleteTaggedworkbook_Response_200: type: object properties: {} title: workbooks_deleteTaggedworkbook_Response_200 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions6' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf0Type: type: string enum: - CSV title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf1Type : type: string enum: - page title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf6Type : type: string enum: - date-list title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf6Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables6: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf6Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables6 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf3Type : type: string enum: - boolean-null title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf3Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf0Type' description: Type of condition elementId: type: string description: ID of the element required: - type - elementId description: If there's no data title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition0 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf0Type: type: string enum: - always title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf0Type V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies0: type: object properties: nodeId: type: string type: type: string required: - nodeId - type title: V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies0 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2: type: object properties: title: type: string description: Title of the message messageBody: type: string description: Body of the message exportAttachments: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItems' description: Attachments to include in the export exportName: type: string description: Name of the scheduled export includeLink: type: boolean description: Include a link to the exported workbook runAsRecipient: type: boolean description: Run the export queries as the recipient attachmentSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2AttachmentSettings' description: Export attachment settings workbookVariant: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookVariant' description: Workbook variant conditionOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions' description: Export condition options workbookSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettings' description: Workbook settings formatting: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2Formatting' description: Export formatting options description: Configuration settings for the export schedule. title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0 DataTypes5: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf5Type' val: type: string description: Set data value required: - type - val title: DataTypes5 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues22 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2Type' value: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems' required: - type - value description: Date list value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues22 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type : type: string enum: - JSON title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf2Type : type: string enum: - text-null title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions3' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type' mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value' required: - type - mode - columnId - op title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8 workbooks_getElementQuery_Response_200: type: object properties: elementId: type: string name: type: string sql: type: string error: type: string required: - elementId title: workbooks_getElementQuery_Response_200 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0Format: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0Format0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0Format1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0Format2' title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0Format V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExport: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExport0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExport1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExport2' title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExport ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf1Type' sheetId: type: string required: - type - sheetId title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItems1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf0Type' required: - type description: Always send the export title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3ValueItemsItemsType : type: string enum: - text title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3ValueItemsItemsType ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type : type: string enum: - CSV title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource4 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type' required: - type description: Export all pages and elements in a workbook title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource4 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf1Type' description: Type of condition elementId: type: string description: ID of the element required: - type - elementId description: If there's data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2Type : type: string enum: - date-list title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2Type V2WorkbooksWorkbookIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: columnId: type: string description: Column ID name: type: string description: Column name formula: type: string description: Column formula or source column reference. type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType' description: The column's data type, represented as a recursive type object. elementId: type: string description: Element ID required: - columnId - name - formula - type - elementId title: V2WorkbooksWorkbookIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues5: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf5Type' min: type: number format: double description: Minimum value of the range max: type: number format: double description: Maximum value of the range required: - type description: Number range value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues5 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaWarningsItems: type: object properties: code: type: string description: Machine-readable warning code, in kebab-case. Treat this as an open set and handle unknown codes gracefully. message: type: string description: Human-readable explanation of the warning. details: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaWarningsItemsDetailsItems' description: Per-element details for this warning, when available. required: - code - message title: V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaWarningsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItemsOneOf1Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItemsOneOf1Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf0Type' date: type: string description: ISO-8601 date string required: - type - date description: Fixed date selection title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type : type: string enum: - page title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems2' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type' sheetId: type: string required: - type - sheetId title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems0 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type WorkbooksListWorkbookSchedulesResponse2001: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItems' nextPage: type: - string - 'null' required: - entries - nextPage title: WorkbooksListWorkbookSchedulesResponse2001 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf0Type' date: type: string description: ISO-8601 date string required: - type - date description: Fixed date selection title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value0 V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1Format1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1FormatOneOf1Type' pixelWidth: type: number format: double pixelHeight: type: number format: double required: - type description: Export options for PNG documents title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1Format1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf0Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf0Type V2WorkbooksWorkbookIdPagesPageIdElementsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: elementId: type: string name: type: string type: type: string columns: type: array items: type: string vizualizationType: type: string error: type: string required: - elementId title: V2WorkbooksWorkbookIdPagesPageIdElementsGetResponsesContentApplicationJsonSchemaEntriesItems V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables5: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf5Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItemsOneOf1Type' required: - type description: Null number value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf0Type : type: string enum: - fixed-date title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf0Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems3' title: V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type' layout: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout' scaleFactor: type: number format: double required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions4 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2Type' conditions: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItems' required: - type - conditions title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions2 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type DashVariablesOneOf5Type: type: string enum: - text-list title: DashVariablesOneOf5Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettings: type: object properties: variables: type: object additionalProperties: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettings DashVariablesOneOf14Type: type: string enum: - hierarchical-list title: DashVariablesOneOf14Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf1Type : type: string enum: - number-null title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type : type: string enum: - NONE title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettings: type: object properties: variables: type: object additionalProperties: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettings ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type' tileId: type: string required: - type - tileId title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems0 V21WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: sheetId: type: string description: Identifier of the materialization schedule for the element elementId: type: string description: Identifier of the element being materialized elementName: type: string schedule: oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsSchedule' - type: 'null' configuredAt: type: string format: date-time paused: type: boolean required: - sheetId - elementId - elementName - schedule - configuredAt - paused title: V21WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaEntriesItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf1Type : type: string enum: - boolean-list title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf1Type DashVariablesOneOf8Max: oneOf: - $ref: '#/components/schemas/DashVariablesOneOf8Max0' - $ref: '#/components/schemas/DashVariablesOneOf8Max1' title: DashVariablesOneOf8Max ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource2' description: Workbook export source options title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf6Type: type: string enum: - table - dataset - data-model - element - customSQL - csv-upload - semantic-view - sql-document - worksheet title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf6Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type : type: string enum: - PNG title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf1Type' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf1Value' required: - type - value description: Boolean list value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSourceOneOf1Type' pageIds: type: array items: type: string description: Array of page identifiers to export required: - type - pageIds description: Export multiple pages title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource1 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2Formatting: type: object properties: pivotHeaderStyle: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2FormattingPivotHeaderStyle' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2Formatting ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type' sheetId: type: string required: - type - sheetId title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItems0 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4 DataTypesOneOf9Val3: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf9ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: DataTypesOneOf9Val3 DashVariables9: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf9Type' min: type: - number - 'null' format: double max: type: - number - 'null' format: double required: - type - min - max title: DashVariables9 V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItems: type: object properties: grantee: $ref: '#/components/schemas/V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee' permission: $ref: '#/components/schemas/V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission' description: Permission to grant for access to the workbook. tagId: type: string required: - grantee - permission title: V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItems V2WorkbooksWorkbookIdSchemaGetResponsesContentApplicationJsonSchemaSqlQueryErrors: type: object properties: message: type: string required: - message title: V2WorkbooksWorkbookIdSchemaGetResponsesContentApplicationJsonSchemaSqlQueryErrors ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf2Type' required: - type description: Null date value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type : type: string enum: - element title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type workbooks_listWorkbookElements_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdElementsGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_listWorkbookElements_Response_200 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf5Type: type: string enum: - number-range title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf5Type V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType8: type: string enum: - date-range title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType8 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2 DataTypes9: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf9Type' val: $ref: '#/components/schemas/DataTypesOneOf9Val' required: - type - val title: DataTypes9 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables8: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf8Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables8 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7 DataTypes_2: oneOf: - $ref: '#/components/schemas/DataTypes0' - $ref: '#/components/schemas/DataTypes1' - $ref: '#/components/schemas/DataTypes2' - $ref: '#/components/schemas/DataTypes3' - $ref: '#/components/schemas/DataTypes4' - $ref: '#/components/schemas/DataTypes5' - $ref: '#/components/schemas/DataTypes6' - $ref: '#/components/schemas/DataTypes7' - $ref: '#/components/schemas/DataTypes8' - $ref: '#/components/schemas/DataTypes9' description: Set a constant value for condition title: DataTypes ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf2Type : type: string enum: - text title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type' pageId: type: string required: - type - pageId description: Export one page title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf3Type : type: string enum: - XLSX title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf3Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3ValueItemsItemsType : type: string enum: - text title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf3ValueItemsItemsType ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf12Type : type: string enum: - text-null title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf12Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf2Type' required: - type description: Null date value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min2 V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies3' title: V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf3Type: type: string enum: - XLSX title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf3Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6 V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0Format2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0FormatOneOf2Type' pixelWidth: type: number format: double pixelHeight: type: number format: double required: - type description: Export options for PNG title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0Format2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions6 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7 V2WorkbooksGetResponsesContentApplicationJsonSchemaEntriesItemsTagsItems: type: object properties: versionTagId: type: string description: Unique identifier of the tag. name: type: string sourceWorkbookVersion: type: number format: double taggedWorkbookId: type: string description: Unique identifier of the tagged workbook. workbookTaggedAt: type: string format: date-time required: - versionTagId - name - sourceWorkbookVersion - taggedWorkbookId - workbookTaggedAt title: V2WorkbooksGetResponsesContentApplicationJsonSchemaEntriesItemsTagsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems2' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1FormatOneOf0Type: type: string enum: - pdf title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1FormatOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val workbooks_deleteWorkbookGrant_Response_200: type: object properties: {} title: workbooks_deleteWorkbookGrant_Response_200 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource2' description: Workbook export source options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsWorkbookExportSource ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf4Type : type: string enum: - number-list title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf4Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf7Type: type: string enum: - webhook title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf7Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3Type: type: string enum: - dashboard title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormatOneOf0Layout: type: string enum: - portrait - landscape description: Page orientation. Defaults to `portrait`. title: V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormatOneOf0Layout V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies2: type: object properties: nodeId: type: string type: type: string name: type: string required: - nodeId - type - name title: V2WorkbooksWorkbookIdLineageElementsElementIdGetResponsesContentApplicationJsonSchemaDependencies2 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExportOneOf2Rs: type: object properties: rsDestination: type: string authorization: type: string required: - rsDestination - authorization title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExportOneOf2Rs V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions3: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3Type' conditions: type: array items: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems' required: - type - conditions title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions3 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItemsOneOf0Type' date: type: string description: ISO-8601 date string required: - type - date description: Fixed date selection title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItems0 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables10: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf10Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables10 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Type' sheetId: type: string mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value' required: - type - sheetId - mode - columnId - op title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems2 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1 DashVariables0: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf0Type' value: type: - boolean - 'null' required: - type - value title: DashVariables0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf9Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables9 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2WorkbookVariant: type: object properties: tagId: type: string exploreKey: type: string bookmarkId: type: string title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2WorkbookVariant V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItemsOneOf3Type: type: string enum: - custom-sql title: V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItemsOneOf3Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AlertConfig: type: object properties: window: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AlertConfigWindow' volume: type: - number - 'null' format: double required: - window title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AlertConfig ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf1Type : type: string enum: - number title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf1Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6Type: type: string enum: - cloud-export title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables8: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf8Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables8 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf3Type' date: type: string description: ISO-8601 date string required: - type - date description: Fixed date selection title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value3 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf1Unit : type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf1Unit DashVariablesOneOf8Min1: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf8MinOneOf1Type' unit: $ref: '#/components/schemas/DashVariablesOneOf8MinOneOf1Unit' x: type: number format: double required: - type - unit - x title: DashVariablesOneOf8Min1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2 V2WorkbooksWorkbookIdElementsElementIdMaterializationSchedulesPostResponsesContentApplicationJsonSchemaSchedule: type: object properties: cronSpec: type: string description: Cron expression to use for the schedule timezone: type: string description: Timezone code, for example, PST title: V2WorkbooksWorkbookIdElementsElementIdMaterializationSchedulesPostResponsesContentApplicationJsonSchemaSchedule workbooks_copyWorkbook_Response_200: type: object properties: workbookId: type: string description: Unique identifier of the workbook. workbookUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number format: double ownerId: type: string createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. isArchived: type: boolean tags: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdCopyPostResponsesContentApplicationJsonSchemaTagsItems' description: type: string taggedSourceUrlId: type: string description: For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request. required: - workbookId - workbookUrlId - name - url - path - latestVersion - ownerId - createdBy - updatedBy - createdAt - updatedAt title: workbooks_copyWorkbook_Response_200 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf1Type' unit: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf1Unit' x: type: number format: double required: - type - unit - x description: Relative date selection, for example "Next 4 days" title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min1 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DashboardSettingsFiltersItems: type: object properties: id: type: string filterStr: type: string required: - id - filterStr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DashboardSettingsFiltersItems ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf3Type : type: string enum: - fixed-date title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf3Type DataTypesOneOf6Type: type: string enum: - error title: DataTypesOneOf6Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf2Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables2 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf5Type : type: string enum: - PNG title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf5Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type : type: string enum: - page title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type DashVariablesOneOf15Type: type: string enum: - file title: DashVariablesOneOf15Type V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType4: type: string enum: - number-list title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType4 V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1: type: object properties: teamId: type: string required: - teamId description: The UUID of the team receiving the grant title: V2WorkbooksWorkbookIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues03: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Type' value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value' description: Date selection required: - type - value description: Date value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues03 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2EmbedOpts: type: object properties: embedId: type: string evalConnectionId: type: string title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2EmbedOpts ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf2Type' required: - type description: JSON export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions2 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3Type' conditions: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems' required: - type - conditions title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions3 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues02 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf2Type' value: type: string required: - type - value description: Text value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues02 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type' pixelWidth: type: - number - 'null' format: double pixelHeight: type: - number - 'null' format: double required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions5 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf2Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf3Type' required: - type title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions3 WorkbooksExportWorkbookRequest2: type: object properties: format: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf2Format' parameters: type: object additionalProperties: type: string description: "Specify the control ID and control value of one or more control elements in the workbook or report to filter the returned data. The control must exist in the Sigma workbook or report and target an element before you can export based on the control value.\n\n**Syntax**\n{ control-id: control-value }\n\nThe control-id is configured in the Sigma workbook or report. The control-value is the value that is passed to the control.\n\nValues can take multiple forms, depending on the data type of the control:\n\n**Boolean**\n\n- Single value: \"true\" | \"false\" | \":null\"\n- List of Boolean: \"true,false,:null\" (No space after the comma.)\n\n**Number**\n\n- Single value: \"10.54\", \":null\"\n- List of values: \"10.54,23.45,:null\" (No space after the comma.)\n- Range of numbers: \"min:10.54,max:23.45\" (No space after the comma or colon.)\n\n**Text**\n\n- Single value: \"some-text\" | \":null\" | \":empty\"\n- List of values: \"some-text,more-text,:null,:empty\" (No space after the comma.)\n\n**Date**\n\nAll dates use UTC time zones.\n\n- Fixed date using ISO-6801 format: \"2022-01-01T01:01:59\" | \":null\"\n - Formats supported (where: %Y: year, %m: month, %d: day, %H:hours, %M: minutes, %S: seconds):\n - %Y-%m-%d\n - %Y-%m-%dT%H:%M\n - %Y-%m-%dT%H:%M:%S\n- List of fixed dates: \"2022-01-01T01:01:59,2022-02-02T02:02:59,:null\"\n- Relative date: \"prior-day-3\" | \"next-day-3\"\n - Format: [prior|next]-[year|quarter|month|week|isoWeek|day|hour|minute]-[number]\n- Date range: \"min:2022-01-01T01:01:59,max:next-day-3\" (No spaces after the comma or colon.)\n - Leave max blank for \"on or after\" and min blank for \"on or before\", for example:\n - \"Date-Range\": \"min:2020-04-01,max:\"\n - \"Date-Range\": \"min:,max:next-day-3\"\n\n**Notes**\n\n- \":null\" is a special value that denotes the null primitive value.\n- \":empty\" is a special value that denotes the empty string \"\".\n\nUse [URL encoding](https://help.sigmacomputing.com/docs/special-characters-for-url-parameters) to encode characters in your control values (such as commas) to prevent the system from interpreting them as separators.\n\nFor example:\n\"New York, NY,Boston, MA\" can be encoded as:\n\n\"New%20York%2C%20NY,Boston%2C%20MA\"" timeout: type: number format: double tag: type: string description: Specifies the version tag of the workbook to be exported. exportAs: type: string description: Specifies the user ID of the Sigma user to run the export queries as, such as to enforce row-level security. Not supported for users who access Sigma with OAuth. rowLimit: type: number format: double description: 'Total number of rows to limit a CSV/XLSX/JSON-formatted export to. ' offset: type: number format: double description: 'The offset number of rows for a CSV/XLSX/JSON-formatted export to start from. ' required: - format description: Export an entire workbook title: WorkbooksExportWorkbookRequest2 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues62: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf2Type' required: - type description: Null text value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues62 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Type : type: string enum: - date title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Type DashVariablesOneOf1Type: type: string enum: - number title: DashVariablesOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItems : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItems0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItems1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItems2' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions3' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions V2WorkbooksWorkbookIdElementsElementIdMaterializationSchedulesPatchResponsesContentApplicationJsonSchemaSchedule: type: object properties: cronSpec: type: string description: Cron expression to use for the schedule timezone: type: string description: Timezone code, for example, PST title: V2WorkbooksWorkbookIdElementsElementIdMaterializationSchedulesPatchResponsesContentApplicationJsonSchemaSchedule ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5 workbooks_listWorkbookPages_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdPagesGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_listWorkbookPages_Response_200 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type : type: string enum: - element title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues2: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues20' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues21' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues22' description: List value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues2 DataTypesOneOf9ValOneOf6Type: type: string enum: - variantArr title: DataTypesOneOf9ValOneOf6Type V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems: type: object properties: columnId: type: string description: Column ID label: type: string description: Column name formula: type: string description: Column formula type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType' description: The column's data type, represented as a recursive type object. required: - columnId - label - formula - type title: V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions2 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf0Type: type: string enum: - CSV title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf0Type DataTypesOneOf9ValOneOf1Type: type: string enum: - numberArr title: DataTypesOneOf9ValOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DashboardSettingsFiltersItems : type: object properties: id: type: string filterStr: type: string required: - id - filterStr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DashboardSettingsFiltersItems ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type : type: string enum: - chartColumn title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions4: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type' layout: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout' scaleFactor: type: number format: double required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions4 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2Formatting: type: object properties: pivotHeaderStyle: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2FormattingPivotHeaderStyle' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2Formatting ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf4Type : type: string enum: - PDF title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf4Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf4Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsSchedule: type: object properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. required: - cronSpec - timezone title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsSchedule ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables: oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables2' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables3' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables4' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables5' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables6' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables7' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables8' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables9' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables10' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables11' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables12' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables13' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0 DataTypesOneOf9Val: oneOf: - $ref: '#/components/schemas/DataTypesOneOf9Val0' - $ref: '#/components/schemas/DataTypesOneOf9Val1' - $ref: '#/components/schemas/DataTypesOneOf9Val2' - $ref: '#/components/schemas/DataTypesOneOf9Val3' - $ref: '#/components/schemas/DataTypesOneOf9Val4' - $ref: '#/components/schemas/DataTypesOneOf9Val5' - $ref: '#/components/schemas/DataTypesOneOf9Val6' title: DataTypesOneOf9Val V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf2Type' nodeIds: type: array items: type: string required: - type - nodeIds description: Export multiple elements title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource2 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf2Type' required: - type title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf8Type : type: string enum: - date-range title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf8Type V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1Format0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1FormatOneOf0Type' layout: $ref: '#/components/schemas/V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1FormatOneOf0Layout' required: - type - layout description: Export options for PDF documents title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf1Format0 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf2Type' required: - type description: Null date value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf2Type' required: - type description: JSON export format options title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions2 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables2: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf2Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf2Type : type: string enum: - JSON title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf2Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables4: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf4Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables4 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions6' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptions0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf6Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions3' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptions ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2WorkbookVariant: type: object properties: tagId: type: string exploreKey: type: string bookmarkId: type: string title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2WorkbookVariant ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type' pixelWidth: type: - number - 'null' format: double pixelHeight: type: - number - 'null' format: double required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions5 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf3Type : type: string enum: - date title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf3Type workbooks_createWorkbook_Response_200: type: object properties: workbookId: type: string description: Unique identifier of the workbook. workbookUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number format: double ownerId: type: string createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. isArchived: type: boolean tags: type: array items: $ref: '#/components/schemas/V2WorkbooksPostResponsesContentApplicationJsonSchemaTagsItems' description: type: string taggedSourceUrlId: type: string description: For a workbook deployed to a tenant organization by a deployment policy with a version tag, the `urlId` of the original source workbook in the parent organization. Only present when `includeTaggedSourceUrlId=true` is included in the request. required: - workbookId - workbookUrlId - name - url - path - latestVersion - ownerId - createdBy - updatedBy - createdAt - updatedAt title: workbooks_createWorkbook_Response_200 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables7: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf7Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables7 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout : type: string enum: - portrait - landscape title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType: type: object properties: {} description: The column's data type, represented as a recursive type object. title: V2WorkbooksWorkbookIdElementsElementIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3 V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItemsOneOf3Type' connectionId: type: string description: ID of the connection where the custom SQL element is run. definition: type: string description: Raw SQL definition for the custom SQL element. customSqlId: type: string description: Element ID of the custom SQL. required: - type - connectionId - definition - customSqlId title: V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItems3 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf0Type : type: string enum: - boolean title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf0Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaSchedule: type: object properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. required: - cronSpec - timezone title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaSchedule workbooks_sendWorkbook_Response_200: type: object properties: {} title: workbooks_sendWorkbook_Response_200 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions0 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions0 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettings: type: object properties: controlValues: type: object additionalProperties: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues' description: This object maps control IDs to the values that they should have when exporting the workbook. description: Workbook settings title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettings DataTypes4: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf4Type' val: type: string description: Set data value required: - type - val title: DataTypes4 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf1Type: type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf1Type DashVariablesOneOf15Value: type: object properties: id: type: string name: type: string size: type: number format: double type: type: string downloadUrl: type: string required: - id - name - size - type - downloadUrl title: DashVariablesOneOf15Value V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition2' title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition DataTypes2: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf2Type' val: type: number format: double description: Set data value required: - type - val title: DataTypes2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf8Type : type: string enum: - date-range title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf8Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf2Type : type: string enum: - text title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf2Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2Type: type: string enum: - worksheet title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3Type: type: string enum: - dashboard title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3Type V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables3: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf3Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables3 DashVariablesOneOf13Type: type: string enum: - boolean-null title: DashVariablesOneOf13Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables5: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf5Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables5 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type : type: string enum: - element title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0 V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItemsOneOf2Type: type: string enum: - table title: V2WorkbooksWorkbookIdSourcesGetResponsesContentApplicationJsonSchemaItemsOneOf2Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode workbooks_tagWorkbook_Response_200: type: object properties: versionTagId: type: string taggedWorkbookId: type: string description: Unique identifier of the workbook. taggedWorkbookVersion: type: number format: double required: - versionTagId - taggedWorkbookId - taggedWorkbookVersion title: workbooks_tagWorkbook_Response_200 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf0Type' value: type: boolean required: - type - value description: Boolean value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf1Type : type: string enum: - prior - next title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf1Type V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItemsMetricMappingItems: type: object properties: fromMetric: type: string description: Metric in the data source. toMetric: type: string description: Metric in the data source. required: - fromMetric - toMetric title: V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItemsMetricMappingItems V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables1: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf1Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type : type: string enum: - datetimeArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type : type: string enum: - EXCEL title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0FormatOneOf1Type: type: string enum: - pdf title: V2WorkbooksWorkbookIdExportPostRequestBodyContentApplicationJsonSchemaOneOf0FormatOneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables0: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf0Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables0 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9 DataTypesOneOf7Type: type: string enum: - record title: DataTypesOneOf7Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf1Type: type: string enum: - JSONL title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigFormatOptionsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type V21WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsSchedule: type: object properties: cronSpec: type: string description: Cron expression to use for the schedule timezone: type: string description: Timezone code, for example, PST title: V21WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsSchedule ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf0Type : type: string enum: - CSV title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf0Type V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaConvertedReport: type: object properties: reportId: type: string description: Unique identifier of the report. reportUrlId: type: string name: type: string url: type: string path: type: string latestVersion: type: number format: double ownerId: type: string createdBy: type: string description: The identifier of the user who created this object. updatedBy: type: string description: The identifier of the user or process that last updated this object. createdAt: type: string format: date-time description: When the object was created. updatedAt: type: string format: date-time description: When the object was last updated. isArchived: type: boolean tags: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaConvertedReportTagsItems' description: type: string required: - reportId - reportUrlId - name - url - path - latestVersion - ownerId - createdBy - updatedBy - createdAt - updatedAt title: V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaConvertedReport DataTypesOneOf4Type: type: string enum: - integer title: DataTypesOneOf4Type V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2Formatting: type: object properties: pivotHeaderStyle: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2FormattingPivotHeaderStyle' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2Formatting ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type : type: string enum: - string title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type DashVariablesOneOf8Min: oneOf: - $ref: '#/components/schemas/DashVariablesOneOf8Min0' - $ref: '#/components/schemas/DashVariablesOneOf8Min1' title: DashVariablesOneOf8Min ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Type : type: string enum: - column description: Type of condition title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables0 V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormat0: type: object properties: pageSize: $ref: '#/components/schemas/V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormatOneOf0PageSize' description: A standard page-size preset. layout: $ref: '#/components/schemas/V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormatOneOf0Layout' description: Page orientation. Defaults to `portrait`. required: - pageSize description: A standard page-size preset (letter, a4, legal, or a3). title: V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormat0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItemsOneOf0Type : type: string enum: - fixed-date title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2ValueItemsOneOf0Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExportOneOf1Sf: type: object properties: sfDestination: type: string authorization: type: string required: - sfDestination - authorization title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExportOneOf1Sf ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables11: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf11Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables11 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource1 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type' pageId: type: string required: - type - pageId description: Export one page title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource1 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf4Type : type: string enum: - PDF title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf4Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type : type: string enum: - PNG title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions6: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf6Type' required: - type title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions6 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf0Type : type: string enum: - fixed-date title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf0Type : type: string enum: - boolean title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type workbooks_getVersionHistory_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdVersionHistoryGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_getVersionHistory_Response_200 DashVariablesOneOf17ValueItems: type: object properties: id: type: string name: type: string size: type: number format: double type: type: string downloadUrl: type: string required: - id - name - size - type - downloadUrl title: DashVariablesOneOf17ValueItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type : type: string enum: - JSONL title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf2Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2FormattingPivotHeaderStyle: type: string enum: - merged - repeated description: Style of pivot table headers title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2FormattingPivotHeaderStyle workbooks_listWorkbookQueries_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdQueriesGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_listWorkbookQueries_Response_200 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf1Type : type: string enum: - prior - next title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf4Type: type: string enum: - number-list title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf4Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf2Type' val: type: number format: double required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf1Type : type: string enum: - prior - next title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4 V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormat: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormat0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormat1' description: Page size and orientation for the report. Defaults to letter portrait. title: V2WorkbooksWorkbookIdConvertToReportPostRequestBodyContentApplicationJsonSchemaFormat ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0Type : type: string enum: - number-list title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3Type: type: string enum: - dashboard title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions6' title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptions V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaConnectionMappingItems: type: object properties: fromId: type: string description: ID of the connection to swap from. toId: type: string description: ID of the connection to swap to. swapTables: type: boolean description: Whether to swap all tables in the connection paths: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaConnectionMappingItemsPathsItems' required: - fromId - toId title: V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaConnectionMappingItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type : type: string enum: - numberArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues61: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf1Type' required: - type description: Null number value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues61 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MinOneOf0Type' date: type: string description: ISO-8601 date string required: - type - date description: Fixed date selection title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min0 V2WorkbooksWorkbookIdElementsElementIdMaterializationSchedulesPatchRequestBodyContentApplicationJsonSchemaSchedule: type: object properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. Defaults to the organization timezone. required: - cronSpec description: When to run the materialization. title: V2WorkbooksWorkbookIdElementsElementIdMaterializationSchedulesPatchRequestBodyContentApplicationJsonSchemaSchedule ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type : type: string enum: - EXCEL title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Op ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type' pixelWidth: type: - number - 'null' format: double pixelHeight: type: - number - 'null' format: double required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2NotificationAttachmentsItemsFormatOptions5 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables7: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf7Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables7 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf4Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value4 V2WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItems: type: object properties: sheetId: type: string description: Identifier of the materialization schedule for the element elementId: type: string description: Identifier of the element being materialized elementName: type: string schedule: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsSchedule' - type: 'null' configuredAt: type: string format: date-time paused: type: boolean required: - sheetId - elementId - elementName - schedule - configuredAt - paused title: V2WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type : type: string enum: - integer title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems2 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type' mode: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode' columnId: type: string op: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op' value: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value' required: - type - mode - columnId - op title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Type: type: string enum: - column description: Type of condition title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Type DataTypes3: type: object properties: type: $ref: '#/components/schemas/DataTypesOneOf3Type' val: type: string description: Set data value required: - type - val title: DataTypes3 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf7Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DashboardSettings: type: object properties: filters: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DashboardSettingsFiltersItems' variableValues: $ref: '#/components/schemas/DashVariables_2' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DashboardSettings ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf4Type' layout: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf4Layout' required: - type description: PDF export format options title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions4 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2EmbedOpts: type: object properties: embedId: type: string evalConnectionId: type: string title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2EmbedOpts ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf2Type' value: type: string required: - type - value description: Text value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf10Type : type: string enum: - date-null title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf10Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf8Type : type: string enum: - date-range title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf8Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions0 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2Type: type: string enum: - worksheet title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems0 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems0 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type : type: string enum: - isNotEmpty title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf1Type workbooks_listWorkbookPageElements_Response_200: type: object properties: entries: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdPagesPageIdElementsGetResponsesContentApplicationJsonSchemaEntriesItems' nextPage: type: - string - 'null' total: type: number format: double required: - entries - nextPage title: workbooks_listWorkbookPageElements_Response_200 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf1Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables1 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf2Type: type: string enum: - JSONL title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode DashVariables15: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf15Type' value: $ref: '#/components/schemas/DashVariablesOneOf15Value' required: - type - value title: DashVariables15 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf6Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value6 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource4: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf4Type' required: - type description: Export all pages and elements in a workbook title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource4 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems4: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf4Type' googleSpreadsheetUrl: type: string required: - type - googleSpreadsheetUrl title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems4 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf0Type : type: string enum: - CSV title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItemsOneOf0Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItemsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf1Type : type: string enum: - prior - next title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf4Type : type: string enum: - number-list title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf4Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1 V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItemsColumnMappingItemsToColumn: oneOf: - type: string - type: array items: type: string title: V2WorkbooksWorkbookIdSwapSourcesPostRequestBodyContentApplicationJsonSchemaSourceMappingItemsColumnMappingItemsToColumn workbooks_materializeWorkbookElement_Response_200: type: object properties: materializationId: type: string required: - materializationId title: workbooks_materializeWorkbookElement_Response_200 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItems: type: object properties: formatOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions' chartId: type: string workbookExportSource: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSource' required: - formatOptions title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItems ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Type' layout: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout' scaleFactor: type: number format: double required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptions4 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf9Type : type: string enum: - number-range title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf9Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf3Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables3 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type : type: string enum: - page title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf3Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type DataTypesOneOf2Type: type: string enum: - number title: DataTypesOneOf2Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value9' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value5 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItems0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type : type: string enum: - PNG title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf2Mode: type: string enum: - any - all description: Check condition title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf2Mode ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf1Unit : type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf1Unit ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf1Type: type: string enum: - isNotEmpty description: Type of condition title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf1Type : type: string enum: - number-null title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf6OneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf5Type: type: string enum: - PNG title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf5Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2: type: object properties: title: type: string messageBody: type: string notificationAttachments: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItems' includeLink: type: boolean runAsRecipient: type: boolean attachmentSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AttachmentSettings' conditionOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions' alertConfig: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2AlertConfig' notificationName: type: string dashboardSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DashboardSettings' dynamicExportSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettings' dynamicRecipientSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicRecipientSettings' rowLimit: type: number format: double workbookVariant: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2WorkbookVariant' embedOpts: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2EmbedOpts' formatting: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2Formatting' - type: 'null' required: - title - messageBody - notificationAttachments title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2 V2WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaOneOf0EntriesItemsSchedule: type: object properties: cronSpec: type: string description: Cron expression to use for the schedule timezone: type: string description: Timezone code, for example, PST title: V2WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaOneOf0EntriesItemsSchedule ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type : type: string enum: - error title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf6Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf9Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value9 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val6' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf1Value : type: object properties: 'true': type: boolean 'false': type: boolean 'null': type: boolean required: - 'true' - 'false' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf1Value V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf0Type: type: string enum: - always title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type : type: string enum: - CSV title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf0Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems2' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaTargetItems: type: object properties: teamId: type: string description: Unique identifier of the team to export to email: type: string description: Email address to export to ccEmail: type: string description: Email address to add as a Cc recipient bccEmail: type: string description: Email address to add as a Bcc recipient ccTeamId: type: string description: Unique identifier of the team to add as a Cc recipient bccTeamId: type: string description: Unique identifier of the team to add as a Bcc recipient slackConversationId: type: string description: Slack channel ID or member ID to export to googleSpreadsheetUrl: type: string description: URL of the Google Sheet to export to googleDriveFolderUrl: type: string description: URL of the Google Drive folder to export to webhookUrl: type: string description: URL of the webhook endpoint to export to title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaTargetItems V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues4: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Type' min: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Min' description: Date selection max: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4Max' description: Date selection required: - type - min - max description: Date range value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues4 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf0Type : type: string enum: - fixed-date title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value0 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2Type : type: string enum: - date-list title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf2Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExport1: type: object properties: sf: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExportOneOf1Sf' required: - sf title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf6CloudExport1 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value9' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItemsOneOf0Type : type: string enum: - text title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItemsOneOf0Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf0Type' required: - type description: CSV export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf5Type : type: string enum: - text-list title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf5Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf1Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1Type : type: string enum: - text-list title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1Type V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaConvertedReportTagsItems: type: object properties: versionTagId: type: string description: Unique identifier of the tag. tagName: type: string sourceVersion: type: number format: double taggedAt: type: string format: date-time taggedReportId: type: string description: Unique identifier of the tagged report. required: - versionTagId - tagName - sourceVersion - taggedAt - taggedReportId title: V2WorkbooksWorkbookIdConvertToReportPostResponsesContentApplicationJsonSchemaConvertedReportTagsItems ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf1Type : type: string enum: - prior - next title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf4MaxOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val DashVariablesOneOf8MaxOneOf1Unit: type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second title: DashVariablesOneOf8MaxOneOf1Unit ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type : type: string enum: - element title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf0Type V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables6' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables7' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables8' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables9' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables10' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables11' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables12' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables13' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Type' description: Type of condition elementId: type: string description: ID of the element columnId: type: string description: ID of the column op: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Op' description: Operator mode: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Mode' description: Kind of condition evaluation value: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value' description: Column value required: - type - elementId - columnId - op - mode description: If a condition is met title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition2 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems0: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type' tileId: type: string required: - type - tileId title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val6' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type : type: string enum: - datetime title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf5Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode1' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Type V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1Type: type: string enum: - workbook title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1Type V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables9: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf9Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables9 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf0Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf3Type: type: string enum: - EXCEL title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf3Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItemsOneOf1Type' required: - type description: Null text value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf0Type' description: Type of condition elementId: type: string description: ID of the element required: - type - elementId description: If there's no data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1Condition0 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues0: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues00' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues01' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues02' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues03' description: Scalar value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItemsOneOf1Type' required: - type description: Null text value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf1ValueItems1 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf0Type : type: string enum: - boolean title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf0Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val : oneOf: - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val2' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val3' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val4' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val5' - $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val6' title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type : type: string enum: - page title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf1Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type : type: string enum: - element title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2NotificationAttachmentsItemsWorkbookExportSourceOneOf2Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2FormattingPivotHeaderStyle: type: string enum: - merged - repeated description: Style of pivot table headers title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2FormattingPivotHeaderStyle ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type : type: string enum: - boolArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value2' description: Date selection title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Value ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues20 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0Type' value: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0ValueItems' required: - type - value description: Number list value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues20 V2WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaOneOf0EntriesItems: type: object properties: sheetId: type: string description: Identifier of the materialization schedule for the element elementId: type: string description: Identifier of the element being materialized elementName: type: string schedule: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaOneOf0EntriesItemsSchedule' - type: 'null' configuredAt: type: string format: date-time paused: type: boolean required: - sheetId - elementId - elementName - schedule - configuredAt - paused title: V2WorkbooksWorkbookIdMaterializationSchedulesGetResponsesContentApplicationJsonSchemaOneOf0EntriesItems ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type : type: string enum: - isEmpty title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf0Type V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables7: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf7Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariables7 workbooks_saveTemplateFromWorkbook_Response_200: type: object properties: templateId: type: string required: - templateId title: workbooks_saveTemplateFromWorkbook_Response_200 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type : type: string enum: - bool title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType11: type: string enum: - number-null title: V2WorkbooksWorkbookIdControlsGetResponsesContentApplicationJsonSchemaEntriesItemsValueType11 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value1 V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookVariant: type: object properties: tagId: type: string description: Version tag to export bookmarkId: type: string description: Bookmark to export description: Workbook variant title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookVariant ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptionsOneOf5Type' required: - type description: PNG export format options title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions5 V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems7: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItemsOneOf7Type' webhookUrl: type: string required: - type - webhookUrl title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaTargetsItems7 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type : type: string enum: - stringArr title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf0Type' data: type: array items: type: - boolean - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val0 ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf1Unit : type: string enum: - year - quarter - month - week - isoWeek - day - hour - minute - second title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3ValueOneOf1Unit V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettings: type: object properties: controlValues: type: object additionalProperties: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues' description: This object maps control IDs to the values that they should have when exporting the workbook. description: Workbook settings title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettings ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout : type: string enum: - portrait - landscape title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf4Layout V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf2Type: type: string enum: - text title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf3Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables3 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues0: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues00' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues01' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues02' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues03' description: Scalar value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode : oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode1' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Mode DashVariables11: type: object properties: type: $ref: '#/components/schemas/DashVariablesOneOf11Type' required: - type title: DashVariables11 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type' val: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val' required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value8 V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems5: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItemsOneOf5Type' connectionId: type: - string - 'null' name: type: - string - 'null' semanticViewId: type: string description: Unique identifier of the semantic view semanticViewTable: type: string description: Name of the table within the semantic view required: - type - connectionId - name - semanticViewId - semanticViewTable title: V2WorkbooksWorkbookIdLineageGetResponsesContentApplicationJsonSchemaEntriesItems5 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type : type: string enum: - variantArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf6Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value3 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type : type: string enum: - 'null' title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf0Type ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val5 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode0 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type : type: string enum: - bytesArr title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf5Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf2Type: type: string enum: - element title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf2Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf1Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf1Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf0Type' required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value0 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions5 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptionsOneOf5Type' pixelWidth: type: - number - 'null' format: double pixelHeight: type: - number - 'null' format: double required: - type title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions5 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1 : type: string enum: - all title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Mode1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf9Type ? V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2ValueOneOf1Type' value: type: string required: - type - value description: Integer value title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionOneOf2Value1 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf3Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables3 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems0 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf0Type' sheetId: type: string required: - type - sheetId title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf1ConditionsItems0 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf1Type: type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf1Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val2 V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables13: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf13Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariables13 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type : type: string enum: - bigintArr title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf2Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf3Type : type: string enum: - date title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf3Type ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf3Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Value3 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf5Type: type: string enum: - text-list title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf5Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8ValOneOf4Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf8Val4 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf5Type' val: type: string required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value5 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItems: type: object properties: formatOptions: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions' chartId: type: string workbookExportSource: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource' required: - formatOptions title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItems ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf12Type : type: string enum: - text-null title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2DynamicExportSettingsVariablesOneOf12Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type' val: type: object additionalProperties: description: Any type required: - type - val title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value7 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0Type : type: string enum: - number-list title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf2OneOf0Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues5: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf5Type' min: type: number format: double description: Minimum value of the range max: type: number format: double description: Maximum value of the range required: - type description: Number range value title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValues5 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Value1 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0 : type: string enum: - any title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Mode0 ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Type : type: string enum: - date title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettingsControlValuesOneOf0OneOf3Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource1: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSourceOneOf1Type' pageId: type: string required: - type - pageId description: Export one page title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsSource1 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8ValOneOf3Type' data: type: array items: type: - string - 'null' required: - type - data title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf8Val3 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type : type: string enum: - chartColumn title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type : type: string enum: - number title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf2Type V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions0' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions1' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions2' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions3' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions4' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions5' - $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions6' description: Export format options title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItemsFormatOptions ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type : type: string enum: - array title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Type V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions2: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2Type' conditions: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems' required: - type - conditions title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptions2 ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables13 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariablesOneOf13Type' required: - type title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2DynamicExportSettingsVariables13 V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2: type: object properties: title: type: string description: Title of the message messageBody: type: string description: Body of the message exportAttachments: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ExportAttachmentsItems' description: Attachments to include in the export exportName: type: string description: Name of the scheduled export includeLink: type: boolean description: Include a link to the exported workbook runAsRecipient: type: boolean description: Run the export queries as the recipient attachmentSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2AttachmentSettings' description: Export attachment settings workbookVariant: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookVariant' description: Workbook variant conditionOptions: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2ConditionOptions' description: Export condition options workbookSettings: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2WorkbookSettings' description: Workbook settings formatting: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2Formatting' description: Export formatting options required: - title - messageBody - exportAttachments description: Configuration settings for the export schedule. title: V2WorkbooksWorkbookIdSchedulesPostRequestBodyContentApplicationJsonSchemaConfigV2 V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions2: type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2Type' conditions: type: array items: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems' required: - type - conditions title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions2 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type : type: string enum: - queryColumn title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Type ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf0ItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type : type: string enum: - record title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf7Type V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettings: type: object properties: variables: type: object additionalProperties: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariables' title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettings V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions3: type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3Type' conditions: type: array items: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItems' required: - type - conditions title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2ConditionOptions3 V2WorkbooksWorkbookIdElementsElementIdMaterializationSchedulesPostRequestBodyContentApplicationJsonSchemaSchedule: type: object properties: cronSpec: type: string description: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`. timezone: type: string description: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`. Defaults to the organization timezone. required: - cronSpec description: When to run the materialization. title: V2WorkbooksWorkbookIdElementsElementIdMaterializationSchedulesPostRequestBodyContentApplicationJsonSchemaSchedule ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf9Type : type: string enum: - number-range title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettingsVariablesOneOf9Type DashVariablesOneOf8MaxOneOf1Type: type: string enum: - prior - next title: DashVariablesOneOf8MaxOneOf1Type workbooks_getWorkbookBookmark_Response_200: type: object properties: bookmarkId: type: string name: type: string isShared: type: boolean description: Whether the bookmark is shared. exploreKey: type: string description: ID of the associated exploration. isDefault: type: boolean description: Whether the bookmark is default. required: - bookmarkId - name - isShared - exploreKey title: workbooks_getWorkbookBookmark_Response_200 V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf11Type: type: string enum: - number-null title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf11Type ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op : type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNotNull - IsNull - Contains - StartsWith - EndsWith title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItemsOneOf2Op V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf4Layout: type: string enum: - portrait - landscape title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaAttachmentsItemsFormatOptionsOneOf4Layout ? V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1 : type: object properties: type: $ref: '#/components/schemas/V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf1Type' val: type: boolean required: - type - val title: V2WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaOneOf1EntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2Value1 workbooks_patchMaterializationSchedule_Response_200: type: object properties: sheetId: type: string description: Identifier of the materialization schedule for the element elementId: type: string description: Identifier of the element being materialized elementName: type: string schedule: oneOf: - $ref: '#/components/schemas/V2WorkbooksWorkbookIdElementsElementIdMaterializationSchedulesPatchResponsesContentApplicationJsonSchemaSchedule' - type: 'null' configuredAt: type: string format: date-time paused: type: boolean required: - sheetId - elementId - elementName - schedule - configuredAt - paused title: workbooks_patchMaterializationSchedule_Response_200 ? V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1 : type: object properties: type: $ref: '#/components/schemas/V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8ValOneOf1Type' data: type: array items: type: - number - 'null' format: double required: - type - data title: V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItemsOneOf2ValueOneOf8Val1 ? V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type : type: string enum: - variant title: V2WorkbooksWorkbookIdSchedulesPostResponsesContentApplicationJsonSchemaConfigV2ConditionOptionsOneOf3ConditionsItemsOneOf2ValueOneOf9Type V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf2Op: type: string enum: - Equals - GreaterThan - GreaterThanEq - LessThan - LessThanEq - NotEquals - IsNull - IsNotNull - Contains - StartsWith - EndsWith description: Operator title: V2WorkbooksWorkbookIdSendPostRequestBodyContentApplicationJsonSchemaConditionsItemsOneOf2Op ? V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf5Type : type: string enum: - text-list title: V2WorkbooksWorkbookIdSchedulesScheduleIdPatchResponsesContentApplicationJsonSchemaConfigV2DynamicExportSettingsVariablesOneOf5Type responses: ApiError: description: Sigma API Error content: application/json: schema: type: object properties: message: type: string code: type: string requestId: type: string securitySchemes: basicAuth: type: http scheme: basic bearerAuth: type: http scheme: bearer oauth2: type: oauth2 flows: clientCredentials: tokenUrl: /v2/auth/token refreshUrl: /v2/auth/token scopes: {} OAuth: type: http scheme: bearer description: OAuth 2.0 authentication x-refined-from: - sigma-computing-public-rest-api-openapi.json - sigma-computing-rest-api-openapi.yaml