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

# Compare Case Version

> Compare a case field version with its immediate predecessor.



## OpenAPI

````yaml https://platform.tracecat.com/api/openapi.json get /workspaces/{workspace_id}/cases/{case_id}/versions/{version_id}/compare
openapi: 3.1.0
info:
  title: Tracecat API
  summary: Tracecat API
  description: The open source AI automation platform for security teams and agents.
  termsOfService: >-
    https://docs.google.com/document/d/e/2PACX-1vQvDe3SoVAPoQc51MgfGCP71IqFYX_rMVEde8zC4qmBCec5f8PLKQRdxa6tsUABT8gWAR9J-EVs2CrQ/pub
  contact:
    name: Tracecat Founders
    email: founders@tracecat.com
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
  version: '1'
servers:
  - url: /api
security: []
tags:
  - name: public
    description: Public facing endpoints
  - name: workflows
    description: Workflow management
  - name: actions
    description: Action management
  - name: triggers
    description: Workflow triggers
  - name: secrets
    description: Secret management
  - name: variables
    description: Workspace variable management
paths:
  /workspaces/{workspace_id}/cases/{case_id}/versions/{version_id}/compare:
    get:
      tags:
        - cases
      summary: Compare Case Version
      description: Compare a case field version with its immediate predecessor.
      operationId: cases-compare_case_version
      parameters:
        - name: case_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Case Id
        - name: version_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Version Id
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaseVersionCompareRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyCookie: []
        - ServiceAccountApiKeyBearer: []
components:
  schemas:
    CaseVersionCompareRead:
      properties:
        selected:
          $ref: '#/components/schemas/CaseVersionContentRead'
        predecessor:
          anyOf:
            - $ref: '#/components/schemas/CaseVersionContentRead'
            - type: 'null'
        diff:
          anyOf:
            - $ref: '#/components/schemas/CaseVersionDiffRead'
            - type: 'null'
      type: object
      required:
        - selected
      title: CaseVersionCompareRead
      description: A selected case version, its predecessor, and their textual diff.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CaseVersionContentRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        field:
          $ref: '#/components/schemas/CaseVersionField'
        version:
          type: integer
          title: Version
        content:
          type: string
          title: Content
      type: object
      required:
        - id
        - field
        - version
        - content
      title: CaseVersionContentRead
      description: Content for one immutable case field version.
    CaseVersionDiffRead:
      properties:
        granularity:
          type: string
          const: word
          title: Granularity
          default: word
        changed:
          type: boolean
          title: Changed
        segments:
          items:
            $ref: '#/components/schemas/CaseVersionDiffSegmentRead'
          type: array
          title: Segments
      type: object
      required:
        - changed
        - segments
      title: CaseVersionDiffRead
      description: A word-level edit script from predecessor to selected content.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    CaseVersionField:
      type: string
      enum:
        - summary
        - description
      title: CaseVersionField
      description: Case text fields that have immutable version history.
    CaseVersionDiffSegmentRead:
      properties:
        operation:
          $ref: '#/components/schemas/CaseVersionDiffOperation'
        text:
          type: string
          title: Text
      type: object
      required:
        - operation
        - text
      title: CaseVersionDiffSegmentRead
      description: One exact-text segment in an ordered case-version diff.
    CaseVersionDiffOperation:
      type: string
      enum:
        - equal
        - insert
        - delete
      title: CaseVersionDiffOperation
      description: Operations in an ordered case-version text diff.
  securitySchemes:
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: fastapiusersauth
    ServiceAccountApiKeyBearer:
      type: http
      description: Tracecat service account API key.
      scheme: bearer

````