---
title: "List SchemaFieldDefinition items"
method: GET
path: "/api/v3/result-schema/{result_schema_id}/field-definitions/items"
tags: ["Result Schema"]
---

# List SchemaFieldDefinition items

`GET /api/v3/result-schema/{result_schema_id}/field-definitions/items`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/result-schema/{result_schema_id}/field-definitions/items`
- Auth: HTTP bearer

List SchemaFieldDefinition items.

## Path parameters

- `result_schema_id` string, required

## Query parameters

- `archived.anyOf` boolean[]

## Headers

- `EARLY-ACCESS` string

## Response `200`

OK

- SchemaFieldDefinitionUnpaginatedList
  - `items` SchemaFieldDefinition[]
    - union
      - object: A schema field definition for linking to AA parts.
        - `__typename` 'AaPartLinkFieldDefinition', required: Discriminator value: AaPartLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent AA part. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` union: Allowed schema types for AA part links.
          - object: AaSequenceSchema variant
            - `__typename` 'AaSequenceSchema', required: Discriminator value: AaSequenceSchema
            - `id` string, api_id
          - object: SystemCategory variant
            - `__typename` 'SystemCategory', required: Discriminator value: SystemCategory
            - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to AA sequences.
        - `__typename` 'AaSequenceLinkFieldDefinition', required: Discriminator value: AaSequenceLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent AA sequence. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` AaSequenceSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to any entity type without schema or type constraints.
        - `__typename` 'AnyEntityLinkFieldDefinition', required: Discriminator value: AnyEntityLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to file attachments.
        - `__typename` 'AttachmentLinkFieldDefinition', required: Discriminator value: AttachmentLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A basic schema field definition for primitive data types. Used for fields with types like TEXT, INTEGER, FLOAT, BOOLEAN, DATE, DATETIME, JSON, and LONG_TEXT. Each field has a user-facing `name` and a `systemName` for warehouse/API access. Fields can be archived when no longer needed. For fields that link to other objects, use `SchemaLinkFieldDefinition`; for dropdown selections, use `DropdownLinkFieldDefinition`.
        - `__typename` 'BaseFieldDefinition', required: Discriminator value: BaseFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean: Determines whether multiple values are allowed
        - `isRequired` boolean: Determines whether values must be provided
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
        - `type` 'AA_PART_LINK' | 'AA_SEQUENCE_LINK' | 'ASSAY_REQUEST_LINK' | 'ASSAY_RESULT_LINK' | 'ASSAY_RUN_LINK' | 'BATCH_LINK' | 'BLOB_LINK' | 'BOOLEAN' | 'CUSTOM_ENTITY_LINK' | 'DATE' | 'DATETIME' | 'DNA_SEQUENCE_LINK' | 'ENTITY_LINK' | 'ENTRY_LINK' | 'FLOAT' | 'INTEGER' | 'JSON' | 'LONG_TEXT' | 'MIXTURE_LINK' | 'MOLECULE_LINK' | 'BASE_MOLECULE_LINK' | 'PART_LINK' | 'RNA_PART_LINK' | 'RNA_SEQUENCE_LINK' | 'SAMPLE_LINK' | 'DROPDOWN' | 'STORAGE_LINK' | 'TEXT' | 'TRANSCRIPTION_LINK' | 'TRANSLATION_LINK'
      - object: A field definition for true/false values. Each field has a user-facing `name` and a `systemName` for warehouse and API access. Stores a single boolean value with no additional type-specific properties.
        - `__typename` 'BooleanFieldDefinition', required: Discriminator value: BooleanFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to custom entities.
        - `__typename` 'CustomEntityLinkFieldDefinition', required: Discriminator value: CustomEntityLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent custom entity. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` CustomEntitySchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A field definition for date-only values, without a time component. Each field has a user-facing `name` and a `systemName` for warehouse and API access. For values that also capture a time and timezone, see `DateTimeFieldDefinition`.
        - `__typename` 'DateFieldDefinition', required: Discriminator value: DateFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A field definition for date and time values with timezone support. Each field has a user-facing `name` and a `systemName` for warehouse and API access. For date-only values without a time component, see `DateFieldDefinition`.
        - `__typename` 'DateTimeFieldDefinition', required: Discriminator value: DateTimeFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A field definition for decimal number values. Supports optional numeric constraints via `numericMin` and `numericMax`, an optional `unit` for associating a measurement unit, and `displayPrecision` to control the number of decimal places shown (0 to 10). For whole number values, see `IntegerFieldDefinition`.
        - `__typename` 'DecimalFieldDefinition', required: Discriminator value: DecimalFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `displayPrecision` integer, nullable: The number of decimal places to display. Null means no display rounding. Valid range: 0 to 10.
        - `id` string
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `legalTextDropdown` DropdownRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `numericMax` number, double, nullable: The maximum allowed value, inclusive. Null means no upper bound.
        - `numericMin` number, double, nullable: The minimum allowed value, inclusive. Null means no lower bound.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
        - `unit` UnitRef
          - `__typename` string
          - `id` string, api_id
      - object: A schema field definition for linking to DNA oligos.
        - `__typename` 'DnaOligoLinkFieldDefinition', required: Discriminator value: DnaOligoLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent DNA Oligo. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` DnaOligoSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to DNA parts.
        - `__typename` 'DnaPartLinkFieldDefinition', required: Discriminator value: DnaPartLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent DNA sequence. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` union: Allowed schema types for DNA part links.
          - object: DnaSequenceSchema variant
            - `__typename` 'DnaSequenceSchema', required: Discriminator value: DnaSequenceSchema
            - `id` string, api_id
          - object: SystemCategory variant
            - `__typename` 'SystemCategory', required: Discriminator value: SystemCategory
            - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to DNA sequences.
        - `__typename` 'DnaSequenceLinkFieldDefinition', required: Discriminator value: DnaSequenceLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent DNA sequence. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` DnaSequenceSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition that links to a dropdown for value selection.
        - `__typename` 'DropdownLinkFieldDefinition', required: Discriminator value: DropdownLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` DropdownRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to notebook entries.
        - `__typename` 'EntryLinkFieldDefinition', required: Discriminator value: EntryLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to equipment.
        - `__typename` 'EquipmentLinkFieldDefinition', required: Discriminator value: EquipmentLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent Equipment. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` EquipmentSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to entities that implement a fieldset (custom schema interface).
        - `__typename` 'FieldsetLinkFieldDefinition', required: Discriminator value: FieldsetLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent entity. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` FieldsetRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A field definition for whole number values. Supports optional numeric constraints via `numericMin` and `numericMax`, and an optional `unit` for associating a measurement unit. For decimal values with display precision control, see `DecimalFieldDefinition`.
        - `__typename` 'IntegerFieldDefinition', required: Discriminator value: IntegerFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `numericMax` number, double, nullable: The maximum allowed value, inclusive. Null means no upper bound.
        - `numericMin` number, double, nullable: The minimum allowed value, inclusive. Null means no lower bound.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
        - `unit` UnitRef
          - `__typename` string
          - `id` string, api_id
      - object: A field definition for storing structured JSON data. Each field has a user-facing `name` and a `systemName` for warehouse and API access. Stores an arbitrary JSON value rather than a single scalar; for plain text, see `TextFieldDefinition` or `LongTextFieldDefinition`.
        - `__typename` 'JsonFieldDefinition', required: Discriminator value: JsonFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A field definition for multi-line text values with no length restrictions. Each field has a user-facing `name` and a `systemName` for warehouse and API access. For short, single-line text, see `TextFieldDefinition`.
        - `__typename` 'LongTextFieldDefinition', required: Discriminator value: LongTextFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to mixtures.
        - `__typename` 'MixtureLinkFieldDefinition', required: Discriminator value: MixtureLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent mixture. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` MixtureSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to molecules.
        - `__typename` 'MoleculeLinkFieldDefinition', required: Discriminator value: MoleculeLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent molecule. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` MoleculeSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to oligo conjugates.
        - `__typename` 'OligoConjugateLinkFieldDefinition', required: Discriminator value: OligoConjugateLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent Oligo Conjugate. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` OligoConjugateSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to oligo duplexes.
        - `__typename` 'OligoDuplexLinkFieldDefinition', required: Discriminator value: OligoDuplexLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent Oligo Duplex. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` OligoDuplexSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to Proteins.
        - `__typename` 'ProteinLinkFieldDefinition', required: Discriminator value: ProteinLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent Protein. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to assay requests.
        - `__typename` 'RequestLinkFieldDefinition', required: Discriminator value: RequestLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to assay results.
        - `__typename` 'ResultLinkFieldDefinition', required: Discriminator value: ResultLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` ResultSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to RNA oligos.
        - `__typename` 'RnaOligoLinkFieldDefinition', required: Discriminator value: RnaOligoLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent RNA Oligo. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` RnaOligoSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to RNA parts.
        - `__typename` 'RnaPartLinkFieldDefinition', required: Discriminator value: RnaPartLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent RNA sequence. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` union: Allowed schema types for RNA part links.
          - object: RnaSequenceSchema variant
            - `__typename` 'RnaSequenceSchema', required: Discriminator value: RnaSequenceSchema
            - `id` string, api_id
          - object: SystemCategory variant
            - `__typename` 'SystemCategory', required: Discriminator value: SystemCategory
            - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to RNA sequences.
        - `__typename` 'RnaSequenceLinkFieldDefinition', required: Discriminator value: RnaSequenceLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent RNA sequence. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` RnaSequenceSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to assay runs.
        - `__typename` 'RunLinkFieldDefinition', required: Discriminator value: RunLinkFieldDefinition
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` RunSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to storable inventory items.
        - `__typename` string, required
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to entities that implement a system category (static schema interface).
        - `__typename` string, required
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A field definition for short, single-line text values. Each field has a user-facing `name` and a `systemName` for warehouse and API access. For multi-line text with no length restrictions, see `LongTextFieldDefinition`.
        - `__typename` string, required
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to transcriptions (RNA sequences created from DNA).
        - `__typename` string, required
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent RNA sequence. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` RnaSequenceSchemaRef
          - `__typename` string
          - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.
      - object: A schema field definition for linking to translations (AA sequences created from RNA).
        - `__typename` string, required
        - `archiveReason` string, nullable: The reason this field definition was archived, if applicable.
        - `archived` boolean: Whether this field definition has been archived.
        - `createdAt` string, datetime, nullable
        - `derivationType` 'DIRECT' | 'COMPUTED' | 'SNAPSHOT': How this field's value is determined: DIRECT (user-entered), COMPUTED (auto-calculated), or SNAPSHOT (frozen at creation).
        - `description` string, nullable: An optional user-provided description of this field definition.
        - `id` string
        - `isMulti` boolean
        - `isParent` boolean: Means the link is from a child to a parent AA sequence. Important for the registry's lot-numbering functionality.
        - `isRequired` boolean: When true, a value must be provided for this field when creating or updating an entity.
        - `linkDefinition` union: Allowed schema types for translation links.
          - object: AaSequenceSchema variant
            - `__typename` 'AaSequenceSchema', required: Discriminator value: AaSequenceSchema
            - `id` string, api_id
          - object: SystemCategory variant
            - `__typename` 'SystemCategory', required: Discriminator value: SystemCategory
            - `id` string, api_id
        - `modifiedAt` string, datetime, nullable
        - `name` string: The user-facing display name of this field definition.
        - `systemName` string: The machine-readable identifier used as the warehouse column name and for API access.

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/c9f087b98b8b?raw)