Protein

Update Protein.

patch/api/v3/protein/{protein_id}

Request

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

Path parameters

protein_idstring required

ID of the Protein.

Request body

aliasesstring[]

Array of aliases

allowCustomFieldDeletionboolean

When true, custom fields present on the entity but omitted from the update payload will be deleted. When false or omitted, omitting existing custom fields is an error. Defaults to false.

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

authorIdsstring[]
customFieldsobject

Custom fields set on the protein.

entityRegistryIdstring

Registry ID to assign to the entity. When registering, specifying this value sets the registry ID of the entity. When already registered, specifying this value updates the entity's registry ID. If set, naming_strategy must be unspecified.

folderIdstring
namestring

Name of the item.

namingStrategy'NEW_IDS' | 'IDS_FROM_NAMES' | 'DELETE_NAMES' | 'SET_FROM_NAME_PARTS' | 'REPLACE_NAMES_FROM_PARTS' | 'KEEP_NAMES' | 'REPLACE_ID_AND_NAME_FROM_PARTS'

Strategy to use for labeling the item in the registry if registering. If one is specified, the entity_registry_id must be unspecified.

registryIdstring nullable

A not null value means the entity should be registered. A null value means it should be unregistered. If not null, the value must match the registry of the item's schema.

schemaFieldsobject

Values for schema-defined fields on this protein.

schemaIdstring
studyIdsstring[]

Study IDS to associate with the item.

Response

OK

__typenamestring
aliasesstring[] nullable

Array of aliases

archiveReasonstring nullable
archivedboolean
createdAtstring datetime

DateTime the protein was created.

entityRegistryIdstring nullable

The registry-assigned identifier for this item (e.g. its registry ID shown in the UI), present only once the item has been registered. Null if the item is not registered.

fullHistorystring uri

fullHistory is a superset of history that also returns inactive versions that are not part of the current version history. Versions are returned in chronological order (oldest first).

historystring uri

Only the currently active version lineage, in chronological order (oldest first).

If a change was made and then undone by resetting to an earlier version, the version recording that change is not relevant to the current state of the entity, so it is not included in this listing.

idstring

ID of the protein.

modifiedAtstring datetime

DateTime the protein was last modified.

namestring

Name of the item.

outOfSyncboolean

Indicates if constituent domain or chain entities have changed since the protein was last updated.

outOfSyncReasonstring nullable

Any additional information about why the protein is out of sync.

authorsstring uri nullable

Changes

    • breaking

      added subschema #1 subschema #8 subschema #9 to the /// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #8 subschema #9 from the /// response property oneOf list for the response status