Microsoft Fabric Activations API

openapi: 3.2.0
info:
  title: Microsoft Fabric Workload Items REST Activations API
  version: v1
  x-source: 'https://github.com/microsoft/fabric-rest-api-specs (bundled from openapi/_original/fabric-rest-api-specs: anomalyDetector/swagger.json, apacheAirflowJob/swagger.json, appBackend/swagger.json, azureDatabricksStorage/swagger.json, copyJob/swagger.json, cosmosDbDatabase/swagger.json, dashboard/swagger.json, dataAgent/swagger.json, dataBuildToolJob/swagger.json, dataPipeline/swagger.json, dataflow/swagger.json, datamart/swagger.json, deploymentPlan/swagger.json, digitalTwinBuilder/swagger.json, digitalTwinBuilderFlow/swagger.json, environment/swagger.json, eventSchemaSet/swagger.json, eventhouse/swagger.json, eventstream/swagger.json, graphModel/swagger.json, graphQLApi/swagger.json, graphQuerySet/swagger.json, kqlDashboard/swagger.json, kqlDatabase/swagger.json, kqlQueryset/swagger.json, lakehouse/swagger.json, map/swagger.json, mirroredAzureDatabricksCatalog/swagger.json, mirroredCatalog/swagger.json, mirroredDatabase/swagger.json, mirroredWarehouse/swagger.json, mlExperiment/swagger.json, mlModel/swagger.json, monitoring/swagger.json, mountedDataFactory/swagger.json, notebook/swagger.json, ontology/swagger.json, operationsAgent/swagger.json, orgApp/swagger.json, orgAppAudience/swagger.json, paginatedReport/swagger.json, plan/swagger.json, policySet/swagger.json, realTimeIntelligence/swagger.json, reflex/swagger.json, report/swagger.json, semanticModel/swagger.json, snowflakeDatabase/swagger.json, spark/swagger.json, sparkjobdefinition/swagger.json, sqlDatabase/swagger.json, sqlEndpoint/swagger.json, userDataFunction/swagger.json, variableLibrary/swagger.json, warehouse/swagger.json)'
servers:
- url: https://api.fabric.microsoft.com/v1
security: []
tags:
- name: Activations
paths:
  /workspaces/{workspaceId}/reflexes/{reflexId}/queryActivations:
    post:
      summary: Executes a KQL query against the activation records of the specified Reflex
      description: 'Executes a KQL query against the activation records of the specified Reflex and returns the results in tabular format. Supports standard KQL data queries (e.g., table queries, `union`, filtering, aggregation) and limited management commands (`.show tables`, `.show table {tableName} cslschema`). Wildcard `union` (e.g. `union *`) is not supported.


        ## Permissions


        The caller must have *read* permission for the reflex.


        ## Required Delegated Scopes


        Reflex.Read.All or Reflex.ReadWrite.All or Item.Read.All or Item.ReadWrite.All


        ## Limitations


        - Maximum query text length: 1,048,576 characters.

        - Queries may time out after approximately 30 seconds.


        ## Microsoft Entra supported identities


        This API supports the Microsoft identities listed in this section.


        | Identity | Support |

        |-|-|

        | User | Yes |

        | Service principal and Managed identities | Yes |


        ## Interface'
      tags:
      - Activations
      operationId: Activations_QueryActivations
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: reflexId
        description: The Reflex ID.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Query executed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryActivationsResponse'
        '429':
          description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
          x-ms-error-response: true
          headers:
            Retry-After:
              description: The number of seconds to wait before retrying the request.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: 'Common error codes:


            * InvalidQuery - The KQL query syntax is invalid.


            * MalformedRuleId - The query references a malformed activation table name or rule ID.


            * DisallowedQueryConstruct - The query uses a construct or management command that is not permitted. Only the `.show tables` and `.show table {tableName} cslschema` management commands are allowed.


            * QueryTooLong - The query text exceeds the maximum length of 1,048,576 characters.


            * ItemNotFound - The specified Reflex item was not found.


            * RuleNotFound - The query references a rule that was not found.


            * QueryTimeout - The query exceeded the maximum duration limit of approximately 30 seconds.


            * ResultTooLarge - The query result exceeds the maximum response size.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryActivationsRequest'
        description: Query activations request payload.
        required: true
components:
  schemas:
    ErrorResponse:
      description: The error response.
      required:
      - message
      - errorCode
      allOf:
      - $ref: '#/components/schemas/ErrorResponseDetails'
      properties:
        requestId:
          type: string
          format: uuid
          description: ID of the request associated with the error.
          readOnly: true
        moreDetails:
          description: List of additional error details.
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseDetails'
          readOnly: true
        isRetriable:
          type: boolean
          description: When true, the request can be retried. Use the `Retry-After` response header to determine the delay, if available.
          readOnly: true
    ActivationsColumn:
      description: Describes a column in the activations query result table.
      type: object
      required:
      - columnName
      - columnType
      properties:
        columnName:
          description: The name of the column.
          type: string
          readOnly: true
        columnType:
          $ref: '#/components/schemas/KustoScalarDataType'
    KustoScalarDataType:
      description: The KQL scalar data type of a column in the activations query result table. Additional KustoScalarDataType values may be added over time.
      type: string
      enum:
      - Bool
      - DateTime
      - Decimal
      - Dynamic
      - Guid
      - Int
      - Long
      - Real
      - String
      - TimeSpan
      x-ms-enum:
        name: KustoScalarDataType
        modelAsString: true
        values:
        - value: Bool
          description: A boolean value (true or false).
        - value: DateTime
          description: A date and time value.
        - value: Decimal
          description: A 128-bit decimal number.
        - value: Dynamic
          description: A dynamic value (JSON-like structure).
        - value: Guid
          description: A globally unique identifier.
        - value: Int
          description: A 32-bit signed integer.
        - value: Long
          description: A 64-bit signed integer.
        - value: Real
          description: A 64-bit floating point number.
        - value: String
          description: A UTF-8 string value.
        - value: TimeSpan
          description: A time interval value.
    QueryActivationsRequest:
      description: Query activations request payload.
      type: object
      required:
      - query
      properties:
        query:
          description: The KQL query string to execute against the activation records. Supports standard KQL data queries (e.g., table queries, `union`, filtering, aggregation) and limited management commands (`.show tables`, `.show table {tableName} cslschema`). Wildcard `union` (e.g. `union *`) is not supported.
          type: string
          maxLength: 1048576
          readOnly: false
    ErrorResponseDetails:
      description: The error response details.
      type: object
      required:
      - message
      - errorCode
      properties:
        errorCode:
          type: string
          description: A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
          readOnly: true
        message:
          type: string
          description: A human readable representation of the error.
          readOnly: true
        relatedResource:
          $ref: '#/components/schemas/ErrorRelatedResource'
        parameters:
          description: Structured parameters providing additional machine-readable context about the error.
          type: array
          items:
            $ref: '#/components/schemas/ErrorParameter'
          readOnly: true
    ErrorRelatedResource:
      description: The error related resource details object.
      type: object
      required:
      - resourceId
      - resourceType
      properties:
        resourceId:
          type: string
          description: The resource ID that's involved in the error.
          readOnly: true
        resourceType:
          type: string
          description: The type of the resource that's involved in the error.
          readOnly: true
    QueryActivationsResponse:
      description: Query activations response. Contains one result table per statement in the query, in source-text order.
      type: object
      required:
      - tables
      properties:
        tables:
          description: An array of result tables. A single-statement query returns one table; a multi-statement query (for example a `.show table {tableName} cslschema` command chained with a data query) returns one table per statement, in source-text order.
          type: array
          items:
            $ref: '#/components/schemas/ActivationsTable'
          readOnly: true
    ActivationsTable:
      description: A single result table returned by an activations query.
      type: object
      required:
      - tableName
      - columns
      - rows
      properties:
        tableName:
          description: The name of the result table. For a standard query, the primary result table is named `PrimaryResult`.
          type: string
          readOnly: true
        columns:
          description: An array describing the columns of the result table.
          type: array
          items:
            $ref: '#/components/schemas/ActivationsColumn'
          readOnly: true
        rows:
          description: An array of row arrays. Each inner array contains values positionally aligned with the columns array.
          type: array
          items:
            type: array
            items:
              description: A single cell value, positionally aligned with the corresponding column. The JSON type of the value reflects the column's KustoScalarDataType (for example string, number, boolean, or null).
          readOnly: true
    ErrorParameter:
      description: A structured parameter providing additional machine-readable context about an error.
      type: object
      properties:
        name:
          type: string
          description: The parameter identifier.
          readOnly: true
        value:
          type: string
          description: The parameter value.
          readOnly: true
        message:
          type: string
          description: A human-readable description of the parameter's meaning.
          readOnly: true