Feature Library Item

Create FeatureLibraryItem

Create FeatureLibraryItem.

post/api/v3/feature-library-item

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Request body

colorstring required

Must be a valid hex color string (for example, #F58A5E).

featureLibraryIdstring required

Feature library id to contain this feature. Each library supports at most 5,000 items.

featureTypestring

The type of the Feature Library Item, like gene, promoter, etc. Note: This is an arbitrary string, not an enum

matchType'NUCLEOTIDE' | 'AA_SEQUENCE' required

Determines how pattern is interpreted during auto-annotation (NUCLEOTIDE or AA_SEQUENCE). Required on create and cannot be changed on update.

namestring required

Item names must be non-empty after trimming whitespace and at most 255 characters.

patternstring required

Patterns must be non-empty and valid for the item's matchType. Nucleotide patterns accept IUPAC bases plus wildcards (#, <, >, ()). Amino acid patterns accept standard residues plus the same wildcard characters. Patterns are compared case-insensitively within a library, so two items cannot differ only by letter case.

Response

Created

__typenamestring
colorstring

The color of the annotations generated by the Feature Library Item. Must be a valid hex string

createdAtstring datetime

DateTime the Feature Library Item was created

featureTypestring nullable

The type of the Feature Library Item, like gene, promoter, etc. Note: This is an arbitrary string, not an enum

idstring
matchType'NUCLEOTIDE' | 'AA_SEQUENCE'

The match type of the Feature Library Item. Used to determine how auto-annotate matches are made

modifiedAtstring datetime

DateTime the Feature Library Item was last modified

namestring

The name of the Feature Library Item

patternstring

The pattern used for matching during auto-annotation

Changes

No recorded changes to this operation across all 3 revisions of this API.