Unit

Get Unit by ID

Get a single Unit by ID.

get/api/v3/unit/{unit_id}

Request

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

Path parameters

unit_idstring required

ID of the Unit.

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.

Response

OK

__typenamestring
aliasesstring[]

Any additional short-form labels that should be recognized in input

archiveReasonstring nullable
archivedboolean
conversionFactorstring decimal

Conversion factor relative to the UnitType's baseUnit. E.g. for a kilometer, the baseUnit is meter and the conversionFactor is 1000.

createdAtstring datetime nullable
idstring
modifiedAtstring datetime nullable
namestring

Default long-form identifier, e.g. "meter".

symbolstring

Default short-form label, e.g. "m" for meter.

Changes

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