Library Parameter Definition

Get LibraryParameterDefinition by ID

Get a single LibraryParameterDefinition by ID.

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

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Headers

EARLY-ACCESSstring

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

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.