Skip to main content
An enum (enumeration) is a string field with a predefined set of values. Define enumerations in the enum sheet of the NEAT physical data model, then reference them in the Value Type column of the Properties sheet.

Defining an enumeration

Add one row per value in the enum sheet. The following table shows CogniteTimeseries.type and CogniteAnnotation.status enumerations from the CogniteCore model.
CollectionValueNameDescription
CogniteTimeseries.typenumericnumericTime series with double floating point data points.
CogniteTimeseries.typestringstringTime series with string data points.
CogniteAnnotation.statusApprovedApproved
CogniteAnnotation.statusRejectedRejected
CogniteAnnotation.statusSuggestedSuggested
The Collection column is the unique identifier for the enumeration. The Value column lists the allowed values. The Name and Description columns are optional and provide the display name and description for each value.

Referencing an enumeration

Reference an enumeration in the Value Type column of the Properties sheet using the syntax enum(collection=). Add an optional unknownValue parameter for unknown values.
ViewView propertyValue typeContainerContainer property
CogniteTimeseriestypeenum(collection=CogniteTimeseries.type)CogniteTimeseriestype
CogniteAnnotationstatusenum(collection=CogniteAnnotation.status)CogniteAnnotationstatus

Further reading

Last modified on February 27, 2026