Sigma Computing

Sigma Computing Data models API

The Data models API from Sigma Computing — 19 operation(s) for data models.

GitHub OpenAPI

Operations 24

GET /v2/dataModels List data models #
GET /v2/dataModels/{dataModelId} Get a data model #
POST /v2/dataModels/{dataModelId}:materialize Run a scheduled materialization for a data model element #
GET /v2/dataModels/{dataModelId}/columns List columns for all elements in a data model #
GET /v2/dataModels/{dataModelId}/elements List elements in a data model #
GET /v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules List column-level security rules on a data model element (Beta) #
POST /v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules Create column-level security rules on a data model element (Beta) #
PUT /v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules/{columnSecurityRuleId} Update a column-level security rule on a data model element (Beta) #
DELETE /v2/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules/{columnSecurityRuleId} Delete a column-level security rule from a data model element (Beta) #
POST /v2/dataModels/{dataModelId}/elements/{elementId}/materializationSchedules Create a materialization schedule for a data model element (Beta) #
PATCH /v2/dataModels/{dataModelId}/elements/{elementId}/materializationSchedules Update a materialization schedule for a data model element (Beta) #
DELETE /v2/dataModels/{dataModelId}/elements/{elementId}/materializationSchedules Delete a materialization schedule for a data model element (Beta) #
GET /v2/dataModels/{dataModelId}/lineage List lineage for a data model #
GET /v2/dataModels/{dataModelId}/materializations/{materializationId} Get a materialization job #
GET /v2/dataModels/{dataModelId}/materializationSchedules List materialization schedules for a data model #
GET /v2/dataModels/{dataModelId}/sources List data model sources #
GET /v2/dataModels/{dataModelId}/spec Get the code representation of a data model #
PUT /v2/dataModels/{dataModelId}/spec Update a data model from a code representation #
POST /v2/dataModels/{dataModelId}/swapSources Swap data model sources #
GET /v2/dataModels/{dataModelId}/tags List tags for a data model #
POST /v2/dataModels/spec Create a data model from a code representation #
POST /v2/dataModels/tag Tag a data model #
POST /v3alpha/dataModels/{dataModelId}:swapSources Swap data model sources (Beta) #
GET /v2/dataModels/{dataModelId}/elements/{elementId}/query Get the SQL query for a data model element #

Documentation

📖
Documentation
https://help.sigmacomputing.com/docs/get-started-with-sigmas-api
📖
APIReference
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
GettingStarted
https://help.sigmacomputing.com/reference/get-started-sigma-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/authentication/sigma-computing-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/rate-limits/sigma-computing-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-data-models-api-openapi.yml

Other Resources

🔗
Examples
https://help.sigmacomputing.com/recipes
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/scopes/sigma-computing-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conventions/sigma-computing-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/errors/sigma-computing-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/data-model/sigma-computing-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/asyncapi/sigma-computing-webhooks.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/conformance/sigma-computing-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/lifecycle/sigma-computing-lifecycle.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sigma-computing-data-models-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sigma-computing-data-models-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sigma Computing Data Models API
  version: '1.0'
  description: 'Operations tagged dataModels 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: Data models
paths:
  /v2/dataModels:
    get:
      summary: List data models
      description: 'This endpoint retrieves a list of all data models available. You can use the response from this endpoint to review existing data models and determine if there are duplicates or gaps.


        ### Usage notes

        This endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit.


        Users with the Admin account type can optionally retrieve all data models in the organization.


        #### Pagination

        This endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows:

        - hasMore: A boolean value indicating whether there are more pages of data available beyond the current page.

        - total: The total number of entries available across all pages.

        - nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data.


        #### Example response for pagination

        {

        "hasMore": true,

        "total": 104,

        "nextPage": "50"

        }

        To request additional pages, include the `nextPage` option in your followup request according to the endpoint''s parameter requirements. This process can be repeated until the `nextPage` option returns `null`, indicating that no further data is available.


        ### Usage scenarios

        - **Data model navigation:** Allows users to easily navigate through their available of data models and access the one they need.

        - **Track lineage**: Identify dependencies and lineage of data sources and data models.'
      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
          description: Whether to exclude additional information about tagged versions of each result
        in: query
      - name: skipPermissionCheck
        schema:
          type: boolean
          description: Only available to Sigma admins. Return all data models, regardless of whether the user has access.
        in: query
      operationId: listDataModels
      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:
                          - dataModelId
                          properties:
                            dataModelId:
                              type: string
                              description: Unique identifier of the data model.
                              title: Data model ID
                        - type: object
                          required:
                          - dataModelUrlId
                          - name
                          - url
                          - path
                          - latestVersion
                          - ownerId
                          properties:
                            dataModelUrlId:
                              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
                                - 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
                      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:
      - Data models
      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/dataModels/{dataModelId}:
    get:
      summary: Get a data model
      description: 'Get details of a specific data model by `dataModelId`.


        ### Usage notes

        - Retrieve the **dataModelId** by calling the /v2/dataModels endpoint.'
      parameters:
      - name: dataModelId
        schema:
          type: string
          description: Unique identifier of the data model.
          title: Data model ID
        in: path
        required: true
      - name: excludeTags
        schema:
          type: boolean
          description: Whether to exclude additional information about tagged versions of each result
        in: query
      operationId: getDataModel
      responses:
        '200':
          description: The response body.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  required:
                  - dataModelId
                  properties:
                    dataModelId:
                      type: string
                      description: Unique identifier of the data model.
                      title: Data model ID
                - type: object
                  required:
                  - dataModelUrlId
                  - name
                  - url
                  - path
                  - latestVersion
                  - ownerId
                  properties:
                    dataModelUrlId:
                      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
                        - 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
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - Data models
      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/dataModels/{dataModelId}:materialize:
    post:
      summary: Run a scheduled materialization for a data model element
      description: 'This endpoint runs a scheduled materialization for an element in a data model. Materialization processes the data of the specified element, allowing the data to be stored or cached for optimized access and performance.


        For more details on materialization, see Materialization.


        ### Usage notes

        - The materialization schedule for the specified element must be created beforehand.

        - Retrieve the **sheetId** by calling the /v2/dataModels/{dataModelId}/materialization-schedules endpoint.

        - Retrieve the **dataModelId** by calling the /v2/dataModels endpoint.


        ### Usage scenarios

        - **Performance optimization:** Use this endpoint to improve response times for frequently accessed data model elements.

        - **Data refresh:** Allows users to manually (programmatically) refresh the data of specific data model elements to ensure that the latest data is available for analysis and reporting.


        ### Best practices

        - Prioritize materialization for elements that are heavily used or form critical components of business reports.

        - Monitor the performance impacts of materialization and adjust strategies as necessary to optimize resource usage and response times.'
      parameters:
      - name: dataModelId
        schema:
          type: string
          description: Unique identifier of the data model.
          title: Data model ID
        in: path
        required: true
      operationId: materializeDataModelElement
      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:
      - Data models
      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/dataModels/{dataModelId}/columns:
    get:
      summary: List columns for all elements in a data model
      description: 'This endpoint retrieves all columns in a data model for all elements in the data model.


        ### Usage notes

        - Retrieve the **dataModelId** by calling the /v2/dataModels endpoint.


        ### Usage scenarios

        - **Data exploration:** Enable users to explore the data structure of a data model element, facilitating deeper analysis and understanding.

        - **Integration tasks:** Useful for developers integrating Sigma with other tools that need to know the data structure to map data accurately.


        ### Best practices

        - Use this endpoint when setting up interfaces that require specific knowledge about the data structure.'
      parameters:
      - name: dataModelId
        schema:
          type: string
          description: Unique identifier of the data model.
          title: Data model 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: getDataModelColumns
      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
        default:
          $ref: '#/components/responses/ApiError'
      externalDocs:
        url: ''
        description: 'Sigma API documentation:'
      tags:
      - Data models
      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/dataModels/{dataModelId}/elements:
    get:
      summary: List elements in a data model
      description: 'This endpoint retrieves details of all elements in a data model, which helps you understand and interact with the individual components that make up the data model, such as tables or controls.

        ### Usage notes

        - Retrieve the **dataModelId** by calling the /v2/dataModels endpoint.

        - To retrieve elements from version-tagged data models, pass the `tagName` in the query parameters with the tag name. Retrieve the tag name by calling the /v2/dataModels/{dataModelId}/tags endpoint and using the `tags.name` included in the response for a given data model.

        ### 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.'
      parameters:
      - name: dataModelId
        schema:
          type: string
          description: Unique identifier of the data model.
          title: Data model 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
      operationId: listDataModelElements
      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:
      - Data models
      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/dataModels/{dataModelId}/elements/{elementId}/columnSecurityRules:
    get:
      summary: List column-level security rules on a data model element (Beta)
      description: 'This endpoint retrieves the column security rules used to configure column-level security (CLS) on a specific element in a data model. Each rule identifies the columns it protects and the criteria that determine which users can view those columns.


        **Beta**: This documentation describes a private beta feature and is subject to the Beta features disclaimer.


        ### Usage notes

        - To perform this operation, you must use API credentials owned by a user with **Can edit** access to the data model.

        - Retrieve the **dataModelId** by calling the /v2/dataModels endpoint.

        - Retrieve the **elementId** by calling the /v2/dataModels/{dataModelId}/elements endpoint.

        - A rule''s `columns` is either a list of column identifiers, or the string `all`, which means the rule applies to every column in the element, including columns added in the future.

        - A rule''s `criteria` describes who can view the restricted columns: no one (`no-one-can-view`), specific users and teams (`specific-users-and-teams`), or users assigned a matching user attribute value (`user-attribute`).


        ### Usage scenarios

        - **Security review:** Allows administrators and data modelers to audit which columns are restricted on an element and who is permitted to view them.

        - **Integration points:** Useful for building governance tooling that needs to report on or reconcile column-level access across data models.'
      parameters:
      - name: dataModelId
        schema:
          type: string
          description: Unique identifier of the data model.
          title: Data model ID
        in: path
        required: true
      - name: elementId
        schema:
          type: string
          description: Unique identifier of the data model 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: quer

# --- truncated at 32 KB (1179 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sigma-computing/refs/heads/main/openapi/sigma-computing-data-models-api-openapi.yml