Skip to content
Cloud APIs
/
FDPlan
/
/kpos

kpos

Manage Key Performance Objectives (KPOs).

Operations

Get all KPOs

Request

Returns the Key Performance Objectives (KPOs) defined for the given study - the per-study targets that bind a referenced KPI to an objective operator and threshold value used to judge scenario success. Requires the studyId of the study whose objectives are being read.

Security
bearer and appkey
Query
studyIdstringrequired

The study which KPOs belongs to.

Headers
slb-partition-idstringrequired

Data partition id.

curl -i -X GET \
  'https://api.delfi.slb.com/fdplan/studies/v1/kpos?studyId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string'

Responses

Retrieved KPOs successfully.

Bodyapplication/json
itemsArray of objects(Kpo)required
Example:
[
  {
    "name": "ATMaxEx",
    "description": "After Tax Maximum Exposure",
    "objectiveOperator": "Less Than",
    "objectiveValue": "600",
    "type": "Money",
    "unit": "M$"
  },
  {
    "name": "ATNPV",
    "description": "After Tax Net Present Value",
    "objectiveOperator": "More than",
    "objectiveValue": "500",
    "type": "Money",
    "unit": "M$"
  }
]
Response
{
  "items": [
    { … },
    { … }
  ]
}