DnaOligo

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/benchling/main/json-schema/benchling-dna-oligo-schema.json",
  "title": "DnaOligo",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/benchling-dna-oligos-api-openapi.yml#/components/schemas/DnaOligo",
  "allOf": [
    {
      "$ref": "#/$defs/Oligo"
    },
    {
      "properties": {
        "annotations": {
          "description": "Annotations on the Oligo.",
          "items": {
            "$ref": "#/$defs/DnaAnnotation"
          },
          "type": "array"
        },
        "apiURL": {
          "type": "string"
        },
        "bases": {
          "type": "string"
        },
        "customNotation": {
          "description": "Representation of the oligo in the custom notation specified in the request. Null if no notation was specified.",
          "type": [
            "string",
            "null"
          ]
        },
        "customNotationName": {
          "description": "Name of the custom notation specified in the request. Null if no notation was specified.",
          "type": [
            "string",
            "null"
          ]
        },
        "helm": {
          "description": "Representation of the oligo in HELM syntax, including any chemical modifications",
          "type": "string"
        }
      }
    }
  ],
  "$defs": {
    "ArchiveRecord": {
      "properties": {
        "reason": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "CustomField": {
      "properties": {
        "value": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "CustomFields": {
      "additionalProperties": {
        "$ref": "#/$defs/CustomField"
      },
      "type": "object"
    },
    "DnaAnnotation": {
      "allOf": [
        {
          "$ref": "#/$defs/SequenceFeatureBase"
        },
        {
          "properties": {
            "end": {
              "description": "0-based exclusive end index. The end of the sequence is always represented as 0.",
              "type": "integer"
            },
            "start": {
              "description": "0-based inclusive start index.",
              "type": "integer"
            },
            "strand": {
              "maximum": 1,
              "minimum": -1,
              "type": "integer"
            },
            "type": {
              "type": "string"
            }
          },
          "type": "object"
        }
      ]
    },
    "Field": {
      "properties": {
        "displayValue": {
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "isMulti": {
          "readOnly": true,
          "type": "boolean"
        },
        "textValue": {
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/FieldType"
            }
          ],
          "readOnly": true
        },
        "value": {
          "description": "For single link fields, use the id of the item you want to link (eg. \"seq_jdf8BV24\").\nFor multi-link fields, use an array of ids of the items you want to link (eg. [\"seq_jdf8BV24\"])\n",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "boolean"
            },
            {
              "type": "number"
            },
            {
              "type": "object"
            },
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          ]
        }
      },
      "required": [
        "value"
      ],
      "type": "object"
    },
    "FieldType": {
      "enum": [
        "dna_sequence_link",
        "aa_sequence_link",
        "custom_entity_link",
        "entity_link",
        "mixture_link",
        "molecule_link",
        "dropdown",
        "part_link",
        "translation_link",
        "aa_part_link",
        "base_molecule_link",
        "blob_link",
        "text",
        "long_text",
        "batch_link",
        "storage_link",
        "entry_link",
        "assay_request_link",
        "assay_result_link",
        "assay_run_link",
        "boolean",
        "float",
        "integer",
        "datetime",
        "date",
        "json"
      ],
      "type": "string"
    },
    "Fields": {
      "additionalProperties": {
        "$ref": "#/$defs/Field"
      },
      "type": "object"
    },
    "Oligo": {
      "properties": {
        "aliases": {
          "description": "Array of aliases",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "apiURL": {
          "description": "The canonical url of the Oligo in the API.",
          "format": "uri",
          "readOnly": true,
          "type": "string"
        },
        "archiveRecord": {
          "allOf": [
            {
              "$ref": "#/$defs/ArchiveRecord"
            }
          ]
        },
        "authors": {
          "items": {
            "$ref": "#/$defs/UserSummary"
          },
          "type": "array"
        },
        "bases": {
          "description": "Base pairs of the Oligo.",
          "type": "string"
        },
        "createdAt": {
          "description": "DateTime the Oligo was created.",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "creator": {
          "$ref": "#/$defs/UserSummary"
        },
        "customFields": {
          "allOf": [
            {
              "$ref": "#/$defs/CustomFields"
            }
          ],
          "description": "Custom fields set on the Oligo."
        },
        "entityRegistryId": {
          "description": "Registry ID of the Oligo if registered.",
          "type": [
            "string",
            "null"
          ]
        },
        "fields": {
          "$ref": "#/$defs/Fields"
        },
        "folderId": {
          "description": "ID of the folder that contains the Oligo.",
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "ID of the Oligo.",
          "type": "string"
        },
        "length": {
          "description": "Number of bases in the Oligo.",
          "type": "integer"
        },
        "modifiedAt": {
          "description": "DateTime the Oligo was last modified.",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "name": {
          "description": "Name of the Oligo.",
          "type": "string"
        },
        "nucleotideType": {
          "description": "Nucleotide type of the Oligo.",
          "enum": [
            "DNA",
            "RNA"
          ],
          "type": "string"
        },
        "registrationOrigin": {
          "allOf": [
            {
              "$ref": "#/$defs/RegistrationOrigin"
            }
          ],
          "readOnly": true
        },
        "registryId": {
          "description": "Registry the Oligo is registered in.",
          "type": [
            "string",
            "null"
          ]
        },
        "schema": {
          "allOf": [
            {
              "$ref": "#/$defs/SchemaSummary"
            }
          ]
        },
        "webURL": {
          "description": "URL of the Oligo.",
          "format": "uri",
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object"
    },
    "PartySummary": {
      "properties": {
        "handle": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "RegistrationOrigin": {
      "properties": {
        "originEntryId": {
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "registeredAt": {
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object"
    },
    "SchemaSummary": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "SequenceFeatureBase": {
      "properties": {
        "color": {
          "description": "Hex color code used when displaying this feature in the UI.",
          "type": "string"
        },
        "customFields": {
          "items": {
            "$ref": "#/$defs/SequenceFeatureCustomField"
          },
          "maxItems": 100,
          "type": "array"
        },
        "name": {
          "maxLength": 2048,
          "type": "string"
        },
        "notes": {
          "maxLength": 10000,
          "type": "string"
        }
      },
      "type": "object"
    },
    "SequenceFeatureCustomField": {
      "description": "A name and value pair associated with a sequence feature (annotation or translation). For genbank imports, these are the qualifiers associated with each feature.",
      "properties": {
        "name": {
          "description": "Name of the custom field",
          "type": "string"
        },
        "value": {
          "description": "Value of the custom field",
          "type": "string"
        }
      },
      "type": "object"
    },
    "UserSummary": {
      "allOf": [
        {
          "$ref": "#/$defs/PartySummary"
        },
        {}
      ]
    }
  }
}