Benchling · Schema

AaSequenceBaseRequest

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

Properties

Name	Type	Description
aliases	array	Aliases to add to the AA sequence
aminoAcids	string	Amino acids for the AA sequence.
annotations	array	Annotations to create on the AA sequence.
authorIds	array	IDs of users to set as the AA sequence's authors.
customFields	object	Custom fields to add to the AA 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 AA 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 AA sequence.
name	string	Name of the AA sequence.
schemaId	string	ID of the AA sequence's schema.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/AaSequenceBaseRequest.json",
  "title": "AaSequenceBaseRequest",
  "properties": {
    "aliases": {
      "description": "Aliases to add to the AA sequence",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "aminoAcids": {
      "description": "Amino acids for the AA sequence.\n",
      "type": "string"
    },
    "annotations": {
      "description": "Annotations to create on the AA sequence.\n",
      "items": {
        "$ref": "#/components/schemas/AaAnnotation"
      },
      "type": "array"
    },
    "authorIds": {
      "description": "IDs of users to set as the AA sequence's authors.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "customFields": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomFields"
        }
      ],
      "description": "Custom fields to add to the AA 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 AA 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 AA sequence.\n",
      "type": "string"
    },
    "name": {
      "description": "Name of the AA sequence.\n",
      "type": "string"
    },
    "schemaId": {
      "description": "ID of the AA sequence's schema.\n",
      "type": "string"
    }
  },
  "type": "object"
}