CreateKpiRequest

descriptionstring^[a-zA-Z0-9\s\-\.\,\;\:\/&]{1,200}$required

The description of KPI.

Example:"Capital Expenditures at first year"

typestringrequired

The value type of KPI.

Enum:"Money""Percentage""Date""Years""Ratio""Volume""Dimensionless"

Example:"Money"

defaultObjectiveOperatorstringrequired

The default objective operator to be used for new KPOs created for the KPI.

Enum:"Less Than""More Than""After""Before"

Example:"Less Than"

unitstring, <= 50 characters

The unit of the KPI.

Example:"M$"

priorityinteger, (int64), >= 1

The priority of the KPI. Increasing value indicates lower priority.

Example:11

archivedboolean

Whether this KPI has been marked as archived.

Example:false

measurementstring^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\...

The measurement for this KPI.

Example:"osdu:reference-data--UnitOfMeasure:1E6%20USD:"

{
  "description": "Capital Expenditures at first year",
  "type": "Money",
  "defaultObjectiveOperator": "Less Than",
  "unit": "M$",
  "priority": 11,
  "archived": false,
  "measurement": "osdu:reference-data--UnitOfMeasure:1E6%20USD:"
}