Create or update a registered DNA sequence

PATCH

https://{tenant_name}.benchling.com/api/v2/dna-sequences/:entity_registry_id:upsert

PATCH

/api/v2/dna-sequences/:entity_registry_id:upsert

curl -X PATCH https://{tenant_name}.benchling.com/api/v2/dna-sequences/entity_registry_id:upsert \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "registryId": "string",
  "schemaId": "string",
  "annotations": [
    {}
  ],
  "bases": "string",
  "isCircular": true,
  "primers": [
    {}
  ]
}'

{
  "aliases": [
    "string"
  ],
  "annotations": [
    {
      "color": "#F58A5E",
      "customFields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "name": "string",
      "notes": "Cong et al Science. 2013 Jan 3.",
      "end": 1,
      "start": 1,
      "strand": 1,
      "type": "string"
    }
  ],
  "apiURL": "https://benchling.com/api/v2/dna-sequences/seq_asQya4lk",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "authors": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "bases": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "customFields": {
    "Legacy ID": {
      "value": "STR100"
    }
  },
  "dnaAlignmentIds": [
    "string"
  ],
  "entityRegistryId": "string",
  "fields": {},
  "folderId": "string",
  "id": "string",
  "isCircular": true,
  "length": 1,
  "modifiedAt": "2024-01-15T09:30:00Z",
  "name": "string",
  "parts": [
    {
      "end": 1,
      "sequenceId": "seq_VfVOART1",
      "start": 1,
      "strand": 1
    }
  ],
  "primers": [
    {
      "bases": "string",
      "bindPosition": 1,
      "color": "string",
      "end": 1,
      "name": "string",
      "oligoId": "string",
      "overhangLength": 1,
      "start": 1,
      "strand": 1
    }
  ],
  "registrationOrigin": {
    "originEntryId": "string",
    "registeredAt": "2024-01-15T09:30:00Z"
  },
  "registryId": "string",
  "schema": {
    "id": "string",
    "name": "string"
  },
  "transcriptions": [
    {
      "end": 1,
      "sequenceId": "seq_VfVOART1",
      "start": 1,
      "strand": 1
    }
  ],
  "translations": [
    {
      "color": "#F58A5E",
      "customFields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "name": "string",
      "notes": "Cong et al Science. 2013 Jan 3.",
      "aminoAcids": "string",
      "coerceStartCodonToMethionine": false,
      "end": 1,
      "geneticCode": "STANDARD",
      "regions": [
        {
          "end": 1,
          "start": 1
        }
      ],
      "start": 1,
      "strand": 1
    }
  ],
  "url": "string",
  "webURL": "string"
}

Create or update a registered DNA sequence.

Schema field links can be populated using entity registry IDs or API IDs. In the value field of the Field resource, the object {"entityRegistryId": ENTITY_REGISTRY_ID} may be provided instead of the API ID if desired (see example value).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entity_registry_idstringRequired

Request

This endpoint expects an object.

namestringRequired

Name of the DNA sequence.

registryIdstringRequired

schemaIdstringRequired

ID of the DNA sequence's schema.

annotationslist of objectsRequired

Annotations to create on the DNA sequence.

basesstringRequired

Base pairs for the DNA sequence.

isCircularbooleanRequired

Whether the DNA sequence is circular or linear.

primerslist of objectsRequired

archiveRecordobjectOptional

Currently, we only support setting a null value for archiveRecord, which unarchives the item

fieldsmap from strings to objectsOptional

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.

aliaseslist of stringsOptional

Aliases to add to the DNA sequence

authorIdslist of stringsOptional

IDs of users to set as the DNA sequence's authors.

customFieldsmap from strings to objectsOptional

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.

folderIdstringOptional

ID of the folder containing the DNA sequence.

partslist of objectsOptional

translationslist of objectsOptional

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.

Response

aliaseslist of stringsOptional

annotationslist of objectsOptional

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the DNA Sequence in the API.

archiveRecordobject or nullOptional

authorslist of objectsOptional

basesstringOptional

createdAtdatetimeOptionalRead-only

creatorobjectOptional

customFieldsmap from strings to objectsOptional

dnaAlignmentIdslist of stringsOptional

API IDs of Nucleotide Alignments involving the RNA sequence

entityRegistryIdstring or nullOptional

fieldsmap from strings to objectsOptional

folderIdstring or nullOptional

idstringOptional

isCircularbooleanOptional

lengthintegerOptional

modifiedAtdatetimeOptionalRead-only

namestringOptional

partslist of objectsOptional

primerslist of objectsOptional

registrationOriginobject or nullOptional

registryIdstring or nullOptional

schemaobject or nullOptional

transcriptionslist of objectsOptional

translationslist of objectsOptional

urlstringOptional

The path of the web URL, omitting the tenant domain

webURLstringOptionalRead-only

Errors

400

Bad Request Error