Skip to content
Cloud APIs
/
/
/
Update an existing Key Pe...

Update an existing Key Performance Indicator (KPI) or create a new one.

Request

Registers a new custom Key Performance Indicator (KPI) or updates an existing one, identified by its immutable kpiName. Use this to extend the partition catalog with metrics beyond the built-in system KPIs. Returns 201 when a KPI is created and 200 when an existing one is updated; built-in system KPIs cannot be modified.

Security
bearer and appkey
Path
kpiNamestring^[a-zA-Z0-9\s\-\.\,\;\:\(\)&]{1,50}$required

The name of the KPI to update or create.

Headers
slb-partition-idstringrequired

Data partition id.

Bodyapplication/jsonrequired

The KPI details to update or create.

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:"
curl -i -X PUT \
  'https://api.delfi.slb.com/fdplan/studies/v1/kpis/{kpiName}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string' \
  -d '{
    "description": "Capital Expenditures at first year",
    "type": "Money",
    "defaultObjectiveOperator": "Less Than",
    "unit": "M$",
    "priority": 11,
    "archived": false,
    "measurement": "osdu:reference-data--UnitOfMeasure:1E6%20USD:"
  }'

Responses

The KPI was updated.

Bodyapplication/json
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:"
namestringrequired

The name of this KPI. This field is immutable.

Example:"First Year Capex"
isSystemboolean

Defines if the KPI is a system KPI.

Example:false
lastUpdatedobject(LastUpdated)

Details of the last update to a resource.

Example:
{
  "atDate": "2020-09-08T09:53:36.000Z",
  "byEvent": "01EHPJ54HEA77K95T5KPH5JSW9",
  "byUser": "user@slb.com"
}
Response
{
  "description": "Capital Expenditures at first year",
  "type": "Money",
  "defaultObjectiveOperator": "Less Than",
  "unit": "M$",
  "priority": 11,
  "archived": false,
  "measurement": "osdu:reference-data--UnitOfMeasure:1E6%20USD:",
  "name": "First Year Capex",
  "isSystem": false,
  "lastUpdated": {
    "atDate": "2020-09-08T09:53:36.000Z",
    "byEvent": "01EHPJ54HEA77K95T5KPH5JSW9",
    "byUser": "user@slb.com"
  }
}