BEbenchling
Library Parameter Definition

Create LibraryParameterDefinition

Create a new library parameter definition in the Parameter Library.

Required fields

FieldDescription
nameDisplay name (1-44 characters, must contain at least one alphanumeric character)
descriptionWhat this parameter measures or represents (max 2048 characters)
dataTypeOne of FLOAT, DATETIME, TEXT, or DROPDOWN

Conditionally required fields

  • unitTypeId — Required when dataType is FLOAT. Must be omitted or null otherwise. Obtain a valid ID from GET /benchling/unit-type/items.
  • schemaFieldSelectorId — Required when dataType is DROPDOWN. Must be omitted or null otherwise. Obtain a valid ID from GET /benchling/dropdown/items.

Notes

  • The creator is automatically set to the authenticated user or app. The deprecated creatorId field is ignored.
  • dataType and unitTypeId are immutable after creation.
  • There is a per-tenant limit on the total number of library parameter definitions.
post/api/v3/library-parameter-definition

Request

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

Headers

EARLY-ACCESSstring

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

Request body

creatorIdstring

Deprecated. This field is ignored — the creator is always set to the authenticated user.

dataType'FLOAT' | 'DATETIME' | 'TEXT' | 'DROPDOWN' required

The data type of values recorded for this parameter. Determines which additional fields are required: FLOAT requires unitTypeId, DROPDOWN requires schemaFieldSelectorId. Cannot be changed after creation.

descriptionstring required

A description of what this parameter measures or represents. Maximum 2048 characters.

namestring required

Display name for the parameter definition. Must contain at least one alphanumeric character. Maximum 44 characters.

unitTypeIdstring nullable

The ID of the unit type for this parameter. Required when dataType is FLOAT, forbidden otherwise. Use GET /benchling/unit-type/items to list available unit types. Format: qnty_XXXXXXXX.

Response

Created

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