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

# Preview



## OpenAPI

````yaml /openapi.json post /v1/workspaces/{workspaceId}/catalog-families/bulk-edit/components/preview
openapi: 3.1.0
info:
  title: Specurate API
  description: ''
  version: 1.0.0
  contact: {}
servers:
  - url: https://app.specurate.com/api
    description: API Server
security: []
tags: []
paths:
  /v1/workspaces/{workspaceId}/catalog-families/bulk-edit/components/preview:
    post:
      tags:
        - Catalog Component Bulk Edit
      summary: Preview
      operationId: CatalogComponentBulkEditController_preview_v1
      parameters:
        - name: workspaceId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CatalogComponentBulkPreviewDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogComponentBulkPreviewResponseDto'
      security:
        - bearer: []
components:
  schemas:
    CatalogComponentBulkPreviewDto:
      type: object
      properties:
        parents:
          minItems: 1
          maxItems: 100
          type: array
          items:
            type: object
            properties:
              familyId:
                type: string
              familyVersion:
                type: integer
                exclusiveMinimum: 0
                maximum: 9007199254740991
              primaryItemId:
                anyOf:
                  - type: string
                  - type: 'null'
              primaryItemVersion:
                anyOf:
                  - type: integer
                    exclusiveMinimum: 0
                    maximum: 9007199254740991
                  - type: 'null'
              primaryFamilySourceId:
                anyOf:
                  - type: string
                  - type: 'null'
              primaryFamilySourceVersion:
                anyOf:
                  - type: integer
                    exclusiveMinimum: 0
                    maximum: 9007199254740991
                  - type: 'null'
              primaryItemSourceId:
                anyOf:
                  - type: string
                  - type: 'null'
              primaryItemSourceVersion:
                anyOf:
                  - type: integer
                    exclusiveMinimum: 0
                    maximum: 9007199254740991
                  - type: 'null'
            required:
              - familyId
              - familyVersion
              - primaryItemId
              - primaryItemVersion
              - primaryFamilySourceId
              - primaryFamilySourceVersion
              - primaryItemSourceId
              - primaryItemSourceVersion
            additionalProperties: false
        componentIds:
          minItems: 1
          maxItems: 100
          type: array
          items:
            type: string
      required:
        - parents
        - componentIds
      additionalProperties: false
    CatalogComponentBulkPreviewResponseDto:
      type: object
      properties:
        schemaVersion:
          type: number
          enum:
            - 1
        selectionMode:
          type: string
        selectedCount:
          type: number
        parents:
          type: array
          items:
            $ref: '#/components/schemas/CatalogComponentBulkParentDto'
        targets:
          type: array
          items:
            $ref: '#/components/schemas/CatalogComponentBulkTargetDto'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/CatalogComponentBulkFieldDto'
        impact:
          $ref: '#/components/schemas/ComponentBulkImpactDto'
      required:
        - schemaVersion
        - selectedCount
        - parents
        - targets
        - fields
        - impact
    CatalogComponentBulkParentDto:
      type: object
      properties:
        familyId:
          type: string
        familyVersion:
          type: number
        primaryItemId:
          type: string
          nullable: true
        primaryItemVersion:
          type: number
          nullable: true
        primaryFamilySourceId:
          type: string
          nullable: true
        primaryFamilySourceVersion:
          type: number
          nullable: true
        primaryItemSourceId:
          type: string
          nullable: true
        primaryItemSourceVersion:
          type: number
          nullable: true
      required:
        - familyId
        - familyVersion
        - primaryItemId
        - primaryItemVersion
        - primaryFamilySourceId
        - primaryFamilySourceVersion
        - primaryItemSourceId
        - primaryItemSourceVersion
    CatalogComponentBulkTargetDto:
      type: object
      properties:
        componentId:
          type: string
        componentVersion:
          type: number
        familyId:
          type: string
        familyVersion:
          type: number
        familySourceId:
          type: string
          nullable: true
        familySourceVersion:
          type: number
          nullable: true
        itemSourceId:
          type: string
          nullable: true
        itemSourceVersion:
          type: number
          nullable: true
        links:
          type: array
          items:
            $ref: '#/components/schemas/ComponentParentLinkDto'
        name:
          type: string
      required:
        - componentId
        - componentVersion
        - familyId
        - familyVersion
        - familySourceId
        - familySourceVersion
        - itemSourceId
        - itemSourceVersion
        - links
        - name
    CatalogComponentBulkFieldDto:
      type: object
      properties:
        fieldKey:
          type: string
        label:
          type: string
        type:
          type: object
        options:
          type: array
          items:
            type: object
        nullable:
          type: boolean
        valueFormat:
          type: string
        scale:
          type: number
        eligibility:
          enum:
            - unavailable
            - editable
          type: string
        reason:
          type: string
          nullable: true
        values:
          type: array
          items:
            $ref: '#/components/schemas/CatalogComponentBulkFieldValueDto'
      required:
        - fieldKey
        - label
        - type
        - options
        - nullable
        - valueFormat
        - eligibility
        - reason
        - values
    ComponentBulkImpactDto:
      type: object
      properties:
        selectedParentCount:
          type: number
        additionalParentCount:
          type: number
        affectedProjectCount:
          type: number
      required:
        - selectedParentCount
        - additionalParentCount
        - affectedProjectCount
    ComponentParentLinkDto:
      type: object
      properties:
        parentId:
          type: string
        parentItemId:
          type: string
        linkId:
          type: string
      required:
        - parentId
        - parentItemId
        - linkId
    CatalogComponentBulkFieldValueDto:
      type: object
      properties:
        value:
          nullable: true
          oneOf:
            - type: string
            - type: number
            - type: boolean
            - type: array
              items:
                type: string
        componentId:
          type: string
      required:
        - value
        - componentId
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````