> ## Documentation Index
> Fetch the complete documentation index at: https://docs.generalvalidation.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the Environment

> The Environment's Fabric workspace, Results Lakehouse, validation pipeline, and workspace identity. Null until an Owner sets up the Environment in the app.

Requires the GV.APIReader application role, or a higher role (Owner > Contributor > Reader).



## OpenAPI

````yaml /api/openapi.json get /api/v1/fabric/settings
openapi: 3.1.0
info:
  description: >-
    General Validation's API for Organization administration, Table Pair and
    Test authoring, Runs, and Result metadata. Microsoft Entra bearer tokens
    authorize every call.
  title: General Validation API
  version: 1.0.0
servers:
  - url: https://api.generalvalidation.com
security: []
tags:
  - description: >-
      Customer-owned Fabric references, immutable Runs, and safe Result
      summaries.
    name: Fabric
  - description: Organizations and verified membership.
    name: Organization
  - description: Subscriptions and entitlements.
    name: Billing
paths:
  /api/v1/fabric/settings:
    get:
      tags:
        - Fabric
      summary: Get the Environment
      description: >-
        The Environment's Fabric workspace, Results Lakehouse, validation
        pipeline, and workspace identity. Null until an Owner sets up the
        Environment in the app.


        Requires the GV.APIReader application role, or a higher role (Owner >
        Contributor > Reader).
      operationId: get_fabric_settings
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/FabricSettings'
                  - type: 'null'
                title: Response Get Fabric Settings
          description: Successful Response
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: A valid Microsoft Entra bearer token is required.
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The authenticated principal does not have the required role.
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The resource does not exist in this tenant.
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The operation conflicts with current resource or Azure state.
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The request is syntactically valid but semantically invalid.
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: The bounded application request rate was exceeded.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                minimum: 1
                type: integer
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/V1Problem'
          description: A required dependency is temporarily unavailable.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                minimum: 1
                type: integer
      security:
        - entraApplication: []
components:
  schemas:
    FabricSettings:
      additionalProperties: false
      properties:
        api_connection_id:
          description: >-
            The connection the validation pipeline uses to report each Run's
            outcome to General Validation.
          format: uuid
          title: Api Connection Id
          type: string
        lakehouse_id:
          description: >-
            The Results Lakehouse in that workspace, where Runs save exact
            values and mismatch evidence.
          format: uuid
          title: Lakehouse Id
          type: string
        pipeline_id:
          description: >-
            The validation pipeline. Start it with Fabric's job API to start a
            Run.
          format: uuid
          title: Pipeline Id
          type: string
        run_connection_id:
          description: >-
            The connection the validation pipeline uses to run the Spark Job
            Definition.
          format: uuid
          title: Run Connection Id
          type: string
        spark_job_definition_id:
          description: The Spark Job Definition that runs validation.
          format: uuid
          title: Spark Job Definition Id
          type: string
        workspace_id:
          description: The Environment's dedicated Fabric workspace.
          format: uuid
          title: Workspace Id
          type: string
        workspace_identity_id:
          description: >-
            The workspace identity's service principal object ID. Validation
            reads Tables as this identity.
          format: uuid
          title: Workspace Identity Id
          type: string
      required:
        - workspace_id
        - lakehouse_id
        - spark_job_definition_id
        - pipeline_id
        - run_connection_id
        - api_connection_id
        - workspace_identity_id
      title: FabricSettings
      type: object
    V1Problem:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable machine-readable error code, such as `precondition.failed`.
            Branch on this value.
          title: Code
          type: string
        detail:
          description: What went wrong in this request, written for a person.
          title: Detail
          type: string
        diagnostics:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          description: >-
            Extra details for some errors, such as `fieldErrors` for an invalid
            request or `requiredRole` for a denied one. Absent when there are
            none.
          title: Diagnostics
        instance:
          description: Path of the request that failed.
          title: Instance
          type: string
        requestId:
          description: >-
            This request's ID, also sent in the `X-Request-Id` response header.
            Quote it when you contact support. A request that sends an
            `X-Request-Id` of 1 to 64 letters, digits, or `_.:-` gets that value
            back.
          title: Requestid
          type: string
        status:
          description: The HTTP status code of this response.
          title: Status
          type: integer
        title:
          description: Short summary of the error code.
          title: Title
          type: string
        type:
          description: Link to the documentation page for this error code.
          title: Type
          type: string
      required:
        - type
        - title
        - status
        - code
        - detail
        - instance
        - requestId
      title: V1Problem
      type: object
  securitySchemes:
    entraApplication:
      bearerFormat: JWT
      description: >-
        Microsoft Entra application token issued by the caller's Organization
        tenant for this multitenant API. Request the .default scope and assign
        the application the required GV.APIReader, GV.APIContributor, or
        GV.APIOwner role.
      scheme: bearer
      type: http
      x-gv-app-roles:
        - GV.APIReader
        - GV.APIContributor
        - GV.APIOwner
      x-gv-audience: 78d5d8af-9dd6-49dd-b06c-38c3a3c707af
      x-gv-scope: api://78d5d8af-9dd6-49dd-b06c-38c3a3c707af/.default
      x-gv-token-url-template: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.