> ## 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.

# Update a Table Pair

> Replace an active Table Pair's name, join keys, and filters. Table references and past Runs remain unchanged.

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



## OpenAPI

````yaml /api/openapi.json put /api/v1/fabric/pairs/{resource_id}
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/pairs/{resource_id}:
    put:
      tags:
        - Fabric
      summary: Update a Table Pair
      description: >-
        Replace an active Table Pair's name, join keys, and filters. Table
        references and past Runs remain unchanged.


        Requires the GV.APIContributor application role, or a higher role (Owner
        > Contributor > Reader).
      operationId: update_fabric_pair
      parameters:
        - description: The Table Pair's ID.
          in: path
          name: resource_id
          required: true
          schema:
            description: The Table Pair's ID.
            format: uuid
            title: Resource Id
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PairDefinition'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TablePair'
          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:
    PairDefinition:
      additionalProperties: false
      properties:
        keys:
          description: >-
            Join keys: the columns that match a source row to its target row.
            `VALUE` and `OUTER_VALUE` Tests need them.
          items:
            $ref: '#/components/schemas/KeyMapping'
          maxItems: 16
          title: Keys
          type: array
        name:
          description: The Table Pair's name.
          maxLength: 255
          minLength: 1
          pattern: ^[^\x00-\x1f\x7f]+$
          title: Name
          type: string
        source_filters:
          description: >-
            Only source rows that match every filter are compared, in every Test
            of the pair.
          items:
            $ref: '#/components/schemas/Filter'
          maxItems: 32
          title: Source Filters
          type: array
        target_filters:
          description: >-
            Only target rows that match every filter are compared, in every Test
            of the pair.
          items:
            $ref: '#/components/schemas/Filter'
          maxItems: 32
          title: Target Filters
          type: array
      required:
        - name
      title: PairDefinition
      type: object
    TablePair:
      additionalProperties: false
      properties:
        id:
          format: uuid
          title: Id
          type: string
        keys:
          description: >-
            Join keys: the columns that match a source row to its target row.
            `VALUE` and `OUTER_VALUE` Tests need them.
          items:
            $ref: '#/components/schemas/KeyMapping'
          maxItems: 16
          title: Keys
          type: array
        name:
          description: The Table Pair's name.
          maxLength: 255
          minLength: 1
          pattern: ^[^\x00-\x1f\x7f]+$
          title: Name
          type: string
        source_filters:
          description: >-
            Only source rows that match every filter are compared, in every Test
            of the pair.
          items:
            $ref: '#/components/schemas/Filter'
          maxItems: 32
          title: Source Filters
          type: array
        source_id:
          description: The source Table's ID.
          format: uuid
          title: Source Id
          type: string
        target_filters:
          description: >-
            Only target rows that match every filter are compared, in every Test
            of the pair.
          items:
            $ref: '#/components/schemas/Filter'
          maxItems: 32
          title: Target Filters
          type: array
        target_id:
          description: The target Table's ID.
          format: uuid
          title: Target Id
          type: string
      required:
        - name
        - source_id
        - target_id
        - id
      title: TablePair
      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
    KeyMapping:
      additionalProperties: false
      properties:
        source:
          description: A source column that identifies a row.
          maxLength: 255
          minLength: 1
          pattern: ^[^\x00-\x1f\x7f]+$
          title: Source
          type: string
        target:
          description: The target column that holds the same identifier.
          maxLength: 255
          minLength: 1
          pattern: ^[^\x00-\x1f\x7f]+$
          title: Target
          type: string
      required:
        - source
        - target
      title: KeyMapping
      type: object
    Filter:
      additionalProperties: false
      properties:
        column:
          description: The column to compare.
          maxLength: 255
          minLength: 1
          pattern: ^[^\x00-\x1f\x7f]+$
          title: Column
          type: string
        operator:
          enum:
            - '='
            - '!='
            - <
            - <=
            - '>'
            - '>='
            - in
            - is_null
            - is_not_null
          title: Operator
          type: string
        value:
          anyOf:
            - maxLength: 1024
              type: string
            - type: boolean
            - type: integer
            - type: number
            - $ref: '#/components/schemas/NumericLiteral'
            - items:
                anyOf:
                  - maxLength: 1024
                    type: string
                  - type: boolean
                  - type: integer
                  - type: number
                  - $ref: '#/components/schemas/NumericLiteral'
              maxItems: 100
              minItems: 1
              type: array
            - type: 'null'
          description: >-
            A string, number, boolean, or exact decimal. `in` takes a list of 1
            to 100 of them; `is_null` and `is_not_null` take none.
          title: Value
      required:
        - column
        - operator
      title: Filter
      type: object
    NumericLiteral:
      additionalProperties: false
      description: An exact decimal, for filter values a JSON number cannot hold exactly.
      properties:
        number:
          maxLength: 128
          pattern: ^[+-]?(?:[0-9]+(?:\.[0-9]*)?|\.[0-9]+)(?:[eE][+-]?[0-9]+)?$
          title: Number
          type: string
      required:
        - number
      title: NumericLiteral
      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.