Benchling · Schema

DnaSequenceBaseRequest

Life SciencesBiotechR&DMolecular BiologyLaboratory Information ManagementElectronic Lab NotebookAssay ManagementInventory ManagementSequence ManagementExperiment WorkflowsRESTWebhooks

Properties

Name Type Description
aliases array Aliases to add to the DNA sequence
annotations array Annotations to create on the DNA sequence.
authorIds array IDs of users to set as the DNA sequence's authors.
bases string Base pairs for the DNA sequence.
customFields object Custom fields to add to the DNA sequence. Every field should have its name as a key, mapping to an object with information about the value of the field.
fields object Fields to set on the DNA sequence. Must correspond with the schema's field definitions. Every field should have its name as a key, mapping to an object with information about the value of the field.
folderId string ID of the folder containing the DNA sequence.
isCircular boolean Whether the DNA sequence is circular or linear.
name string Name of the DNA sequence.
parts array
primers array
schemaId string ID of the DNA sequence's schema.
translations array Translations to create on the DNA sequence. Translations are specified by either a combination of 'start' and 'end' fields, or a list of regions. Both cannot be provided.
View JSON Schema on GitHub

JSON Schema

DnaSequenceBaseRequest.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/DnaSequenceBaseRequest.json",
  "title": "DnaSequenceBaseRequest",
  "properties": {
    "aliases": {
      "description": "Aliases to add to the DNA sequence",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "annotations": {
      "description": "Annotations to create on the DNA sequence.\n",
      "items": {
        "$ref": "#/components/schemas/DnaAnnotation"
      },
      "type": "array"
    },
    "authorIds": {
      "description": "IDs of users to set as the DNA sequence's authors.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "bases": {
      "description": "Base pairs for the DNA sequence.\n",
      "type": "string"
    },
    "customFields": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomFields"
        }
      ],
      "description": "Custom fields to add to the DNA sequence. Every field should have its name as a key, mapping to an object with information about the value of the field.\n"
    },
    "fields": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Fields"
        }
      ],
      "description": "Fields to set on the DNA sequence. Must correspond with the schema's field definitions. Every field should have its name as a key, mapping to an object with information about the value of the field.\n"
    },
    "folderId": {
      "description": "ID of the folder containing the DNA sequence.\n",
      "type": "string"
    },
    "isCircular": {
      "description": "Whether the DNA sequence is circular or linear.\n",
      "type": "boolean"
    },
    "name": {
      "description": "Name of the DNA sequence.\n",
      "type": "string"
    },
    "parts": {
      "items": {
        "$ref": "#/components/schemas/DnaSequencePart"
      },
      "type": "array"
    },
    "primers": {
      "items": {
        "$ref": "#/components/schemas/Primer"
      },
      "type": "array"
    },
    "schemaId": {
      "description": "ID of the DNA sequence's schema.\n",
      "type": "string"
    },
    "translations": {
      "description": "Translations to create on the DNA sequence. Translations are specified by either a combination of 'start' and 'end' fields, or a list of regions. Both cannot be provided.\n",
      "items": {
        "$ref": "#/components/schemas/Translation"
      },
      "type": "array"
    }
  },
  "type": "object"
}