measurements

List Measurements

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.

get/measurements

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/measurements
  • Auth: API key in header x-api-key

Query parameters

type'MEASUREMENT' | 'SUB_CALCULATION'

Filter by measurement type

include_archivedboolean

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

pageinteger

Page number (1-based)

page_sizeinteger

Number of items per page (max 100)

Response

List of measurements

idinteger required

Measurement identifier

namestring required

Measurement name

type'MEASUREMENT' | 'SUB_CALCULATION' required

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

minimumValuenumber double nullable

Minimum allowed value. Only meaningful for type MEASUREMENT.

isArchivedboolean

Whether this measurement has been archived.

Changes

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