Flatfile subpackage_data-clips API

openapi: 3.2.0
info:
  title: Reference subpackage_accounts Subpackage Data Clips API
  version: 1.0.0
servers:
- url: https://api.x.flatfile.com/v1
tags:
- name: subpackage_data-clips
paths:
  /data-clips:
    post:
      operationId: create
      summary: Create
      description: Creates a new DataClip.
      tags:
      - subpackage_data-clips
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-clips_DataClip'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_data-clips_CreateDataClipRequest'
    get:
      operationId: list
      summary: List
      tags:
      - subpackage_data-clips
      parameters:
      - name: spaceId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_SpaceId'
      - name: sheetId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons_SheetId'
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-clips_ListDataClipResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
  /data-clips/{dataClipId}:
    patch:
      operationId: update
      summary: Update
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_DataClipId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-clips_DataClipResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_data-clips_UpdateDataClipRequest'
    delete:
      operationId: delete
      summary: Delete
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_DataClipId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Success'
    get:
      operationId: get
      summary: Get
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_DataClipId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-clips_DataClipResponse'
  /data-clips/{dataClipId}/add-records:
    post:
      operationId: add-records-to-clip
      summary: Add Records To Clip
      description: Adds records to an existing DataClip.
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_DataClipId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_records_RecordsResponseData'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_data-clips_AddRecordsToClipRequest'
  /data-clips/{dataClipId}/resolutions:
    get:
      operationId: get-resolutions
      summary: Get Resolutions
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_DataClipId'
      - name: includeRecords
        in: query
        description: Include records in the response. Default is true
        required: false
        schema:
          type: boolean
      - name: includeSummary
        in: query
        description: Include summary in the response. Default is false
        required: false
        schema:
          type: boolean
      - name: filterColumn
        in: query
        description: The column to filter by.
        required: false
        schema:
          type: string
      - name: filterConflicts
        in: query
        description: Whether to filter only conflicts. Default is false
        required: false
        schema:
          type: boolean
      - name: pageSize
        in: query
        description: Number of resolutions to return in a page. Default is 1000
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Page number of resolutions to return
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_records_DiffRecordsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
    patch:
      operationId: update-resolution
      summary: Update Resolution
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_DataClipId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_data-clips_UpdateResolutionRequest'
  /data-clips/{dataClipId}/resolutions/index:
    get:
      operationId: get-resolution-index
      summary: Get Resolution Index
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_DataClipId'
      - name: filterColumn
        in: query
        description: The column to filter by.
        required: false
        schema:
          type: string
      - name: filterConflicts
        in: query
        description: Whether to filter only conflicts. Default is false
        required: true
        schema:
          type: string
      - name: id
        in: query
        description: The record ID to get the index of.
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-clips_GetResolutionIndexResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
  /data-clips/{dataClipId}/refresh-resolutions:
    patch:
      operationId: refresh-resolutions
      summary: Refresh Resolutions
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons_DataClipId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons_Errors'
components:
  schemas:
    type_data-clips_ResolvedRecords:
      type: object
      properties:
        recordId:
          $ref: '#/components/schemas/type_commons_RecordId'
          description: The record ID to update
        resolves:
          type: array
          items:
            $ref: '#/components/schemas/type_data-clips_Resolve'
          description: The resolutions for the record
      required:
      - recordId
      - resolves
      title: ResolvedRecords
    type_commons_SpaceId:
      type: string
      description: Space ID
      title: SpaceId
    type_commons_Error:
      type: object
      properties:
        key:
          type: string
        message:
          type: string
      required:
      - message
      title: Error
    type_commons_CommitId:
      type: string
      description: Commit ID
      title: CommitId
    type_records_ValidationType:
      type: string
      enum:
      - error
      - warn
      - info
      title: ValidationType
    type_records_DiffRecord:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons_RecordId'
        versionId:
          $ref: '#/components/schemas/type_commons_VersionId'
          description: Deprecated, use `commitId` instead.
        commitId:
          $ref: '#/components/schemas/type_commons_CommitId'
        valid:
          type: boolean
          description: Auto-generated value based on whether the record contains a field with an error message. Cannot be set via the API.
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records_ValidationMessage'
          description: This record level `messages` property is deprecated and no longer stored or used. Use the `messages` property on the individual cell values instead. This property will be removed in a future release.
        metadata:
          type: object
          additionalProperties:
            description: Any type
        config:
          $ref: '#/components/schemas/type_records_RecordConfig'
        values:
          $ref: '#/components/schemas/type_records_DiffData'
        resolves:
          type: array
          items:
            $ref: '#/components/schemas/type_data-clips_Resolve'
      required:
      - id
      - values
      title: DiffRecord
    type_commons_VersionId:
      type: string
      description: Version ID
      title: VersionId
    type_data-clips_AddRecordsToClipRequest:
      type: object
      properties:
        recordIds:
          type: array
          items:
            $ref: '#/components/schemas/type_commons_RecordId'
      required:
      - recordIds
      title: AddRecordsToClipRequest
    type_data-clips_UpdateDataClipRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the DataClip.
        description:
          type: string
          description: A description of the DataClip.
        status:
          type: string
          description: The status of the DataClip.
        collaborators:
          type: array
          items:
            type: string
          description: The list of collaborators.
        sharedLinkAccess:
          $ref: '#/components/schemas/type_data-clips_SharedLinkAccess'
          description: The type of shared link to generate for the DataClip.
      required:
      - name
      title: UpdateDataClipRequest
    type_data-clips_SharedLinkAccess:
      type: string
      enum:
      - public
      - restricted
      title: SharedLinkAccess
    type_records_RecordsWithLinks:
      type: array
      items:
        $ref: '#/components/schemas/type_records_RecordWithLinks'
      description: List of Record objects, including links to related rows
      title: RecordsWithLinks
    type_records_CellValue:
      type: object
      properties:
        valid:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records_ValidationMessage'
        metadata:
          type: object
          additionalProperties:
            description: Any type
          description: Deprecated, use record level metadata instead.
        value:
          $ref: '#/components/schemas/type_records_CellValueUnion'
        layer:
          type: string
        updatedAt:
          type: string
          format: date-time
      title: CellValue
    type_data-clips_GetResolutionIndexResponse:
      type: object
      properties:
        index:
          type: integer
          description: Zero-based index of the record in the filtered list
      required:
      - index
      title: GetResolutionIndexResponse
    type_data-clips_ResolveTo:
      type: string
      enum:
      - clip
      - main
      - snapshot
      title: ResolveTo
    type_records_RecordData:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/type_records_CellValue'
      description: A single row of data in a Sheet
      title: RecordData
    type_records_RecordsResponseData:
      type: object
      properties:
        success:
          type: boolean
        records:
          $ref: '#/components/schemas/type_records_RecordsWithLinks'
        counts:
          $ref: '#/components/schemas/type_records_RecordCounts'
        versionId:
          $ref: '#/components/schemas/type_commons_VersionId'
          description: Deprecated, use `commitId` instead.
        commitId:
          $ref: '#/components/schemas/type_commons_CommitId'
      required:
      - success
      title: RecordsResponseData
    type_data-clips_ListDataClipResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_data-clips_DataClipResponse'
      required:
      - data
      title: ListDataClipResponse
    type_records_RecordCounts:
      type: object
      properties:
        total:
          type: integer
        valid:
          type: integer
        error:
          type: integer
        errorsByField:
          type: object
          additionalProperties:
            type: integer
        byField:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/type_records_FieldRecordCounts'
          description: Counts for valid, error, and total records grouped by field key
      required:
      - total
      - valid
      - error
      title: RecordCounts
    type_commons_Success:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_commons_SuccessData'
      description: Informs whether or not a request was successful
      title: Success
    type_commons_SuccessData:
      type: object
      properties:
        success:
          type: boolean
      required:
      - success
      title: SuccessData
    type_records_FieldRecordCounts:
      type: object
      properties:
        total:
          type: integer
        valid:
          type: integer
        error:
          type: integer
        empty:
          type: integer
      required:
      - total
      - valid
      - error
      - empty
      title: FieldRecordCounts
    type_records_Record:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons_RecordId'
        versionId:
          $ref: '#/components/schemas/type_commons_VersionId'
          description: Deprecated, use `commitId` instead.
        commitId:
          $ref: '#/components/schemas/type_commons_CommitId'
        valid:
          type: boolean
          description: Auto-generated value based on whether the record contains a field with an error message. Cannot be set via the API.
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records_ValidationMessage'
          description: This record level `messages` property is deprecated and no longer stored or used. Use the `messages` property on the individual cell values instead. This property will be removed in a future release.
        metadata:
          type: object
          additionalProperties:
            description: Any type
        config:
          $ref: '#/components/schemas/type_records_RecordConfig'
        values:
          $ref: '#/components/schemas/type_records_RecordData'
      required:
      - id
      - values
      description: A single row of data in a Sheet
      title: Record
    type_commons_Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/type_commons_Error'
      required:
      - errors
      title: Errors
    type_data-clips_CreateDataClipRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the DataClip.
        description:
          type: string
          description: A description of the DataClip.
        sourceSheetId:
          $ref: '#/components/schemas/type_commons_SheetId'
          description: The ID of the source sheet.
        collaborators:
          type: array
          items:
            type: string
          description: The list of collaborators.
        sharedLinkAccess:
          $ref: '#/components/schemas/type_data-clips_SharedLinkAccess'
          description: The type of shared link to generate for the DataClip.
      required:
      - name
      - sourceSheetId
      title: CreateDataClipRequest
    type_records_RecordWithLinks:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons_RecordId'
        values:
          $ref: '#/components/schemas/type_records_RecordDataWithLinks'
        valid:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records_ValidationMessage'
        metadata:
          type: object
          additionalProperties:
            description: Any type
        config:
          $ref: '#/components/schemas/type_records_RecordConfig'
      required:
      - id
      - values
      description: A single row of data in a Sheet, including links to related rows
      title: RecordWithLinks
    type_commons_JSONPathString:
      type: string
      description: A JSONPath string - https://www.rfc-editor.org/rfc/rfc9535
      title: JSONPathString
    type_data-clips_RemovedFromMainResolution:
      type: string
      enum:
      - ignore
      - restore
      title: RemovedFromMainResolution
    type_records_DiffRecordsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_records_DiffRecords'
      required:
      - data
      title: DiffRecordsResponse
    type_data-clips_ResolveType:
      type: string
      enum:
      - conflict
      - resolve
      title: ResolveType
    type_commons_DataClipId:
      type: string
      description: Data Clip ID
      title: DataClipId
    type_records_CellValueUnion:
      oneOf:
      - type: string
      - type: integer
      - type: integer
        format: int64
      - type: number
        format: double
      - type: boolean
      - type: string
        format: date
      - type: string
        format: date-time
      - type: array
        items:
          type: string
      title: CellValueUnion
    type_records_DiffValue:
      type: object
      properties:
        valid:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records_ValidationMessage'
        metadata:
          type: object
          additionalProperties:
            description: Any type
          description: Deprecated, use record level metadata instead.
        value:
          $ref: '#/components/schemas/type_records_CellValueUnion'
        layer:
          type: string
        updatedAt:
          type: string
          format: date-time
        snapshotValue:
          $ref: '#/components/schemas/type_records_CellValueUnion'
        clipValue:
          $ref: '#/components/schemas/type_records_CellValueUnion'
        warning:
          type: boolean
        warnings:
          type: array
          items:
            type: string
      title: DiffValue
    type_records_ValidationSource:
      type: string
      enum:
      - required-constraint
      - unique-constraint
      - custom-logic
      - unlinked
      - invalid-option
      - is-artifact
      title: ValidationSource
    type_records_Records:
      type: array
      items:
        $ref: '#/components/schemas/type_records_Record'
      description: List of Record objects
      title: Records
    type_data-clips_DataClipResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_data-clips_DataClip'
          description: The list of DataClips.
      required:
      - data
      title: DataClipResponse
    type_records_ValidationMessage:
      type: object
      properties:
        field:
          type: string
        type:
          $ref: '#/components/schemas/type_records_ValidationType'
        source:
          $ref: '#/components/schemas/type_records_ValidationSource'
        message:
          type: string
        path:
          $ref: '#/components/schemas/type_commons_JSONPathString'
          description: This JSONPath is based on the root of mapped cell object.
      description: Record data validation messages
      title: ValidationMessage
    type_records_CellConfig:
      type: object
      properties:
        readonly:
          type: boolean
      description: CellConfig
      title: CellConfig
    type_data-clips_Resolve:
      type: object
      properties:
        field:
          type: string
        type:
          $ref: '#/components/schemas/type_data-clips_ResolveType'
        resolveTo:
          $ref: '#/components/schemas/type_data-clips_ResolveTo'
        clip_value_reference:
          type: string
        main_value_reference:
          type: string
        removedFromMainResolution:
          $ref: '#/components/schemas/type_data-clips_RemovedFromMainResolution'
      description: Conflict resolutions for a record
      title: Resolve
    type_records_DiffRecords:
      type: array
      items:
        $ref: '#/components/schemas/type_records_DiffRecord'
      description: List of DiffRecord objects
      title: DiffRecords
    type_records_DiffData:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/type_records_DiffValue'
      title: DiffData
    type_records_CellValueWithLinks:
      type: object
      properties:
        valid:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records_ValidationMessage'
        metadata:
          type: object
          additionalProperties:
            description: Any type
          description: Deprecated, use record level metadata instead.
        value:
          $ref: '#/components/schemas/type_records_CellValueUnion'
        layer:
          type: string
        updatedAt:
          type: string
          format: date-time
        links:
          $ref: '#/components/schemas/type_records_Records'
      title: CellValueWithLinks
    type_commons_SheetId:
      type: string
      description: Sheet ID
      title: SheetId
    type_data-clips_UpdateResolutionRequest:
      type: object
      properties:
        resolvedRecords:
          type: array
          items:
            $ref: '#/components/schemas/type_data-clips_ResolvedRecords'
          description: Array of record-specific resolutions to update
      required:
      - resolvedRecords
      title: UpdateResolutionRequest
    type_data-clips_DataClip:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons_DataClipId'
        name:
          type: string
          description: The name of the DataClip.
        description:
          type: string
          description: A description of the DataClip.
        sourceSheetId:
          $ref: '#/components/schemas/type_commons_SheetId'
          description: The ID of the source sheet.
        clipSheetId:
          $ref: '#/components/schemas/type_commons_SheetId'
          description: The ID of the sheet that is clipped from source sheet.
        workbookId:
          type: string
          description: The ID of the workbook.
        status:
          type: string
          description: The status of the DataClip.
        createdBy:
          type: string
          description: The user who created the DataClip.
        mergedAt:
          type: string
          format: date-time
          description: The date when the DataClip was merged.
        deletedAt:
          type: string
          format: date-time
          description: The date when the DataClip was deleted.
        updatedAt:
          type: string
          format: date-time
          description: The date when the DataClip was updated.
        createdAt:
          type: string
          format: date-time
          description: The date when the DataClip was created.
        guestLinkUrl:
          type: string
          description: A URL for guests to access the DataClip.
        accessToken:
          type: string
          description: A signed token associated with the guest link.
        sharedLinkAccess:
          type: string
          description: Indicates the shared link access level, public or restricted
      required:
      - id
      - name
      - sourceSheetId
      - clipSheetId
      - workbookId
      - status
      - createdBy
      - updatedAt
      - createdAt
      title: DataClip
    type_records_RecordConfig:
      type: object
      properties:
        readonly:
          type: boolean
        fields:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/type_records_CellConfig'
        markedForDeletion:
          type: boolean
      description: Configuration of a record or specific fields in the record
      title: RecordConfig
    type_commons_RecordId:
      type: string
      description: Record ID
      title: RecordId
    type_records_RecordDataWithLinks:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/type_records_CellValueWithLinks'
      description: A single row of data in a Sheet, including links to related rows
      title: RecordDataWithLinks
  securitySchemes:
    default:
      type: http
      scheme: bearer