Create or update a registered AA sequence.

PATCH

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

PATCH

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

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

{
  "aliases": [
    "string"
  ],
  "aminoAcids": "IKTATARRELAETSWTGDRLWGFSDNWAPALRRPSPSALGK",
  "annotations": [
    {
      "color": "string",
      "end": 1,
      "id": "prtnann_o7zMPG0P",
      "name": "string",
      "notes": "Cong et al Science. 2013 Jan 3.",
      "start": 1,
      "type": "Site"
    }
  ],
  "apiURL": "https://benchling.com/api/v2/aa-sequences/prtn_7nMBOMm0",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "authors": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "customFields": {},
  "entityRegistryId": "string",
  "fields": {},
  "folderId": "string",
  "id": "prtn_ObbdtGhC",
  "length": 1,
  "modifiedAt": "2024-01-15T09:30:00Z",
  "name": "string",
  "registrationOrigin": {
    "originEntryId": "string",
    "registeredAt": "2024-01-15T09:30:00Z"
  },
  "registryId": "string",
  "schema": {
    "id": "string",
    "name": "string"
  },
  "url": "string",
  "webURL": "https://benchling.com/benchling/f/lib_55UxcIps-registry/prtn_7nMBOMm0-kedchain11/edit\""
}

Create or update a registered AA 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 AA sequence.

registryIdstringRequired

schemaIdstringRequired

ID of the AA sequence's schema.

entityRegistryIdstringRequired

Registry ID of the entity in Benchling.

aminoAcidsstringRequired

Amino acids for the AA sequence.

annotationslist of objectsRequired

Annotations to create on the AA sequence.

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

aliaseslist of stringsOptional

Aliases to add to the AA sequence

authorIdslist of stringsOptional

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

customFieldsmap from strings to objectsOptional

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.

folderIdstringOptional

ID of the folder containing the AA sequence.

Response

aliaseslist of stringsOptional

Array of aliases

aminoAcidsstringOptional

Amino acids of the AA sequence.

annotationslist of objectsOptional

Array of annotation objects on the AA sequence.

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the AA Sequence in the API.

archiveRecordobject or nullOptional

authorslist of objectsOptional

createdAtdatetimeOptionalRead-only

DateTime the AA sequence was created.

creatorobjectOptional

customFieldsmap from strings to objectsOptional

Custom fields set on the AA sequence.

entityRegistryIdstring or nullOptional

Registry ID of the AA sequence if registered.

fieldsmap from strings to objectsOptional

folderIdstring or nullOptional

ID of the folder that contains the AA sequence.

idstringOptional

ID of the AA sequence.

lengthintegerOptional

Number of amino acids in the AA sequence.

modifiedAtdatetimeOptionalRead-only

DateTime the AA sequence was last modified.

namestringOptional

Name of the AA sequence.

registrationOriginobject or nullOptional

registryIdstring or nullOptional

Registry the AA sequence is registered in.

schemaobject or nullOptional

urlstringOptional

The path of the web URL, omitting the tenant domain

webURLstringOptionalRead-onlyformat: "uri"

URL of the AA sequence.

Errors

400

Bad Request Error