Skip to content
Cloud APIs
/
FDPlan
/
/Scores

Scores

Manage scenario ranking scores.

Operations

Get ranking scores for the scenarios in the given study ID.

Request

Returns the ranking scores computed for the scenarios in the given study, used to compare and rank candidate development options. Set includeCriteriaScores to also return the per-criterion score breakdown; results are paginated with the pageNumber and pageSize parameters.

Security
bearer and appkey
Query
studyIdstringrequired

The ID of the study for which to get the scenario ranking scores

pageNumberinteger

The number of the page in the list of ranking scores.

Default:0
pageSizeinteger, <= 500

The number of ranking scores per page.

Default:100
includeCriteriaScoresboolean

Whether to include criteria scores break-down in the response

Default:false
Headers
slb-partition-idstringrequired

Data partition id.

curl -i -X GET \
  'https://api.delfi.slb.com/fdplan/studies/v1/scenario-ranking-scores?studyId=string&pageNumber=0&pageSize=100&includeCriteriaScores=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string'

Responses

Success.

Bodyapplication/json
itemsArray of objects(ScenarioScore)required

The ranking scores.

Response
{
  "items": [
    { … }
  ]
}