List Measurements | Coperniq API

const url = 'https://api.coperniq.io/v1/measurements';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

[
  {
    "id": 1,
    "name": "string",
    "type": "MEASUREMENT",
    "unit": {
      "id": 1,
      "code": "string",
      "label": "string",
      "dimension": "LENGTH",
      "isCustom": true,
      "isArchived": true
    },
    "minimumValue": 1.1,
    "formula": {
      "operands": [
        {
          "name": "string",
          "measurementId": 1
        }
      ],
      "ast": {},
      "sourceText": "string"
    },
    "isArchived": true
  }
]

Lists the measurements (and sub-measurements) available to your company. Use these IDs when setting measurementIds on a catalog item. A “sub-measurement” is a measurement with type: SUB_CALCULATION.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

typeenumOptional

Filter by measurement type

Allowed values:

include_archivedbooleanOptionalDefaults to false

Whether to include archived (inactive) records in the response. By default only active records are returned.

pageintegerOptional>=1Defaults to 1

Page number (1-based)

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

Response

List of measurements

idinteger

Measurement identifier

namestring

Measurement name

typeenum

A plain MEASUREMENT is a raw input value; a SUB_CALCULATION (“sub-measurement”) derives its value from a formula over other measurements.

unitobject or nullOptional

The unit this measurement is expressed in, if any.

minimumValuedouble or nullOptional

Minimum allowed value. Only meaningful for type MEASUREMENT.

formulaobjectOptional

The formula driving a SUB_CALCULATION measurement’s quantity. Read-only — there is no API to create or edit a measurement’s formula; it can only be authored in the app. Shape: operands names each referenced measurement ({name, measurementId}); ast is a binary-operation tree (ADD/SUB/MUL/DIV) whose leaves are either {operandRef} (referencing an entry in operands by name) or {constant} (a literal number); sourceText is the original formula text as authored.

isArchivedbooleanOptional

Whether this measurement has been archived.

Errors

400

Bad Request Error

401

Unauthorized Error

502

Bad Gateway Error