Create UnitType

POST

https://{tenant_name}.benchling.com/api/v3/unit-type

POST

/api/v3/unit-type

curl -X POST https://{tenant_name}.benchling.com/api/v3/unit-type \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "baseUnit": {
    "aliases": [
      "aliases"
    ],
    "name": "name",
    "symbol": "symbol"
  },
  "name": "name",
  "overrideIsConcentration": true,
  "overrideIsContainerQuantity": true
}'

{
  "__typename": "__typename",
  "archiveReason": "archiveReason",
  "archived": true,
  "baseUnit": {
    "__typename": "__typename",
    "id": "id"
  },
  "createdAt": "createdAt",
  "formula": [
    {
      "__typename": "__typename",
      "exponent": 1
    }
  ],
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "overrideIsConcentration": true,
  "overrideIsContainerQuantity": true,
  "terms": [
    {
      "__typename": "__typename",
      "exponent": 1,
      "value": "TIME"
    }
  ],
  "units": "units"
}

Create UnitType.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

baseUnitobjectRequired

The reference unit for this type.

namestringRequired

The name of this unit type, e.g. "Volume".

overrideIsConcentrationbooleanRequired

When true, forces this UnitType to be treated as a concentration type regardless of its terms. When false, the classification is determined by the UnitType's terms. Mutually exclusive with overrideIsContainerQuantity.

overrideIsContainerQuantitybooleanRequired

When true, forces this UnitType to be treated as a container quantity type regardless of its terms. When false, the classification is determined by the UnitType's terms. Mutually exclusive with overrideIsConcentration.

formulalist of objectsOptional

Formula defining this type in terms of other units.

Response

Created

__typenamestringOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

baseUnitobject or nullOptional

The reference unit. All other units' conversionFactors are relative to this unit. Null for unit types with no units yet.

createdAtstring or nullOptional

formulalist of objects or nullOptional

Defines this unit type in terms of other units for derived types, e.g. Liter = decimeter cubed.

idstringOptional

modifiedAtstring or nullOptional

namestringOptional

The user-facing name, e.g. “Volume” or “Molar Concentration”.

overrideIsConcentrationboolean or nullOptional

When true, forces this UnitType to be treated as a concentration type regardless of its terms. When false, the classification is determined by the UnitType’s terms. Mutually exclusive with overrideIsContainerQuantity.

overrideIsContainerQuantityboolean or nullOptional

When true, forces this UnitType to be treated as a container quantity type regardless of its terms. When false, the classification is determined by the UnitType’s terms. Mutually exclusive with overrideIsConcentration.

termslist of objectsOptional

The dimensional composition of this unit type as a list of SI base dimensions with exponents.

unitsstring or nullOptionalformat: "uri"

All units belonging to this unit type.

Errors

400

Unit Type Create Request Bad Request Error

403

Unit Type Create Request Forbidden Error

404

Unit Type Create Request Not Found Error

409

Unit Type Create Request Conflict Error

429

Unit Type Create Request Too Many Requests Error

500

Unit Type Create Request Internal Server Error