Create or update a registered RNA oligo

PATCH

https://{tenant_name}.benchling.com/api/v2/rna-oligos/:entity_registry_id:upsert

PATCH

/api/v2/rna-oligos/:entity_registry_id:upsert

curl -X PATCH https://{tenant_name}.benchling.com/api/v2/rna-oligos/entity_registry_id_001:upsert \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "registryId": "string",
  "schemaId": "string"
}'

{
  "aliases": [
    "string"
  ],
  "annotations": [
    {
      "color": "#F58A5E",
      "customFields": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "end": 1,
      "name": "string",
      "notes": "Cong et al Science. 2013 Jan 3.",
      "start": 1,
      "strand": 1,
      "type": "string"
    }
  ],
  "apiURL": "https://benchling.com/api/v2/rna-oligos/seq_bhuDUw9D",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "authors": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "bases": "ACUUUUU",
  "createdAt": "2024-01-15T09:30:00Z",
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "customFields": {},
  "customNotation": "string",
  "customNotationName": "string",
  "entityRegistryId": "string",
  "fields": {},
  "folderId": "string",
  "helm": "RNA1{r(A)p.r(C)[Ssp].r(U)p.r(U)p.r(U)p.r(U)p.r(U)p}$$$$V2.0",
  "id": "seq_bhuDUw9D",
  "length": 1,
  "modifiedAt": "2024-01-15T09:30:00Z",
  "name": "string",
  "nucleotideType": "RNA",
  "registrationOrigin": {
    "originEntryId": "string",
    "registeredAt": "2024-01-15T09:30:00Z"
  },
  "registryId": "string",
  "schema": {
    "id": "string",
    "name": "string"
  },
  "webURL": "https://benchling.com/benchling/f/lib_hBHqKbzE-oligos/seq_bhuDUw9D-test-oligo-abc/edit"
}

Create or update a registered RNA oligo.

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 Oligo.

registryIdstringRequired

schemaIdstringRequired

ID of the oligo's schema.

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 Oligo. 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 Oligo

authorIdslist of stringsOptional

IDs of users to set as the Oligo's authors.

basesstringOptional

Base pairs of the oligo.

customFieldsmap from strings to objectsOptional

Custom fields to add to the Oligo. 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 Oligo.

Response

Updated

Errors

400

Bad Request Error