BEbenchling
Library Parameter Definition

Update LibraryParameterDefinition

Update a library parameter definition.

Updatable fields

FieldDescription
nameDisplay name (1-44 characters, at least one alphanumeric character)
descriptionParameter description (max 2048 characters)

Archiving

To archive, set all three fields together:

  • archived: true
  • archiveReason: a non-empty string explaining why
  • archiveUserId: the ID of the user performing the archive (format: ent_XXXXXXXX)

To unarchive, set archived to false.

Immutable fields

The following fields are set at creation and cannot be changed via update:

  • dataType
  • unitTypeId
patch/api/v3/library-parameter-definition/{library_parameter_definition_id}

Request

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

Path parameters

library_parameter_definition_idstring required

ID of the LibraryParameterDefinition.

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Request body

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.

descriptionstring

Updated description. Maximum 2048 characters.

namestring

Updated display name. Must contain at least one alphanumeric character. Maximum 44 characters.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime
dataType'AA_PART_LINK' | 'AA_SEQUENCE_LINK' | 'ASSAY_REQUEST_LINK' | 'ASSAY_RESULT_LINK' | 'ASSAY_RUN_LINK' | 'BATCH_LINK' | 'BLOB_LINK' | 'BOOLEAN' | 'CUSTOM_ENTITY_LINK' | 'DATE' | 'DATETIME' | 'DNA_SEQUENCE_LINK' | 'ENTITY_LINK' | 'ENTRY_LINK' | 'FLOAT' | 'INTEGER' | 'JSON' | 'LONG_TEXT' | 'MIXTURE_LINK' | 'MOLECULE_LINK' | 'BASE_MOLECULE_LINK' | 'PART_LINK' | 'RNA_PART_LINK' | 'RNA_SEQUENCE_LINK' | 'SAMPLE_LINK' | 'DROPDOWN' | 'STORAGE_LINK' | 'TEXT' | 'TRANSCRIPTION_LINK' | 'TRANSLATION_LINK'
descriptionstring
idstring
modifiedAtstring datetime
namestring

Changes

No recorded changes to this operation across all 1 revision of this API.