Unit

Update Unit

Update Unit.

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

Request body

aliasesstring[]

Alternative abbreviations for this unit, e.g. alternate symbols.

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.

namestring

The long-form name, e.g. "milliliter".

symbolstring

The short-form label, e.g. "mL".

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.