{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Studies","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":true,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"studies","__idx":0},"children":["Studies"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The studies API is responsible for study data within FDPlan."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The key API concepts include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studies"]},": A study covers the allocation of time and resources to gain"," ","knowledge of an asset, identify potential opportunities and threats,"," ","derive and evaluate candidate development scenarios, and make critical"," ","decisions in field-development planning. It can also be referred to as an"," ","asset evaluation project or a conceptual field-development planning"," ","project. You can have several studies for different stages of"," ","field-development planning, such as one study for the appraisal stage and"," ","another for the concept selection stage."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["KPOs"]},": A key performance objective (KPO) is an objective that is"," ","critical to the success of the project. Typically, three to five"," ","objectives are identified as key objectives."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["KPIs"]},": A key performance indicator (KPI) represents the performance"," ","of the current development scenario compared with the key performance"," ","objective, for example, net present value (NPV),"," ","internal rate of return (IRR), payback period, date of first oil,"," ","maximum exposure, and proven reserves."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["decisions"]},": A decision must be made or has been made to define the"," ","field-development plan. It can contain one or more available choices to"," ","select. A decision is made when one of the available choices is selected."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["choices"]},": A choice is an option you can choose to make a decision. It"," ","can also be referred to as a concept. There can be multiple available"," ","choices in making a decision. A choice can be available or unavailable,"," ","and can be selected or unselected."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["scenarios"]},": A scenario is a combination of development choices that"," ","describes a particular way to develop a field. It can also be referred to"," ","as a development scenario, a concept, or a development option."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["deliverables"]},": A deliverable is a work item in which you can manage the"," ","life cycle of the required data or the documents for a study. It holds the"," ","information on the status of the domain contribution, the contributors,"," ","the approvers, and the due date. A contribution that fulfills a"," ","deliverable is referred to as an 'data source'."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"table-of-contents","__idx":1},"children":["Table of contents",{"$$mdtype":"Tag","name":"a","attributes":{"name":"toc"},"children":[]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-the-list-of-key-performance-indicators-(kpis)"},"children":["Get the list of Key Performance Indicators (KPIs)."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#update-an-existing-key-performance-indicator-(kpi)-or-create-a-new-one"},"children":["Update an existing Key Performance Indicator (KPI) or create a new one."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-all-studies"},"children":["Get all studies"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-a-new-study"},"children":["Create a new study"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-a-study"},"children":["Get a study"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#delete-a-study"},"children":["Delete a study."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#update-a-study"},"children":["Update a study."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-all-kpos"},"children":["Get all KPOs"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-all-scenarios"},"children":["Get all scenarios"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#create-a-new-scenario"},"children":["Create a new scenario"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#delete-a-scenario"},"children":["Delete a scenario"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#update-a-scenario"},"children":["Update a scenario"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-scenario-results-state"},"children":["Get scenario results state"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-all-deliverables"},"children":["Get all deliverables"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-a-deliverable"},"children":["Get a deliverable"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#update-a-deliverable"},"children":["Update a deliverable"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-the-list-of-opportunities-for-the-given-study"},"children":["Get the list of opportunities for the given study."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#get-ranking-scores-for-the-scenarios-in-the-given-study-id"},"children":["Get ranking scores for the scenarios in the given study ID"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-the-list-of-key-performance-indicators-kpis","__idx":2},"children":["Get the list of Key Performance Indicators (KPIs). ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-the-list-of-key-performance-indicators-(kpis)"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pageNumber"]}," The number of the page in the list of KPIs"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pageSize"]}," The number of KPIs per page"]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/kpis' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","["," ","{"," ","\"name\": \"First Year Capex\","," ","\"isSystem\": false,"," ","\"lastUpdated\": {"," ","\"atDate\": \"2022-03-08T08:53:36.000Z\","," ","\"byEvent\": \"01EHPJ54HEA77K95T5KPH5JSW9\","," ","\"byUser\": \"user@slb.com\""," ","},"," ","\"description\": \"Capital Expenditures at first year\","," ","\"type\": \"Money\","," ","\"defaultObjectiveOperator\": \"Less Than\","," ","\"unit\": \"M$\","," ","\"priority\": 11,"," ","\"archived\": false"," ","},"," ","{"," ","\"name\": \"First Oil\","," ","\"isSystem\": false,"," ","\"lastUpdated\": {"," ","\"atDate\": \"2022-03-08T09:53:36.000Z\","," ","\"byEvent\": \"01EHPJ54HEA77K95T5KPH5JSW9\","," ","\"byUser\": \"user@slb.com\""," ","},"," ","\"description\": \"Date of First Oil\","," ","\"type\": \"Date\","," ","\"defaultObjectiveOperator\": \"Before\","," ","\"priority\": 14,"," ","\"archived\": false"," ","}"," ","]"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"update-an-existing-key-performance-indicator-kpi-or-create-a-new-one","__idx":3},"children":["Update an existing Key Performance Indicator (KPI) or create a new one. ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"update-an-existing-key-performance-indicator-(kpi)-or-create-a-new-one"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["kpiName"]}," The name of the KPI to update or create."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["data"]}," The KPI details to update or create."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request PUT ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/kpis/{kpiName}' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '{"," ","\"description\": \"Capital Expenditures at first year\","," ","\"type\": \"Money\","," ","\"defaultObjectiveOperator\": \"Less Than\","," ","\"unit\": \"M$\","," ","\"priority\": 11,"," ","\"archived\": false,"," ","\"measurement\": \"osdu:reference-data--UnitOfMeasure:1E6%20USD:\""," ","}'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-all-studies","__idx":4},"children":["Get all studies ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-all-studies"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get all studies."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/studies' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","["," ","{"," ","\"id\": \"01CP3E6EJJ25J29YHZ0K4RDZH8\","," ","\"title\": \"Robin Field Development\","," ","\"description\": \"New development opportunity.\","," ","\"country\": \"US\","," ","\"isArchived\": false,"," ","\"workflowSpec\": {"," ","\"id\": \"01FDYW0CS3RS1Z9BHE53DATBDE\","," ","\"version\": 1"," ","}"," ","},"," ","{"," ","\"id\": \"02DSFJLKJL34HGH6DFLKGJJ9L8\","," ","\"title\": \"Forties Field Development\","," ","\"description\": \"Workover project.\","," ","\"country\": \"UK\","," ","\"isArchived\": false,"," ","\"workflowSpec\": {"," ","\"id\": \"01FDYW0CS3V4V36DVSTH7BJNBY\","," ","\"version\": 2"," ","}"," ","}"," ","]"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"create-a-new-study","__idx":5},"children":["Create a new study ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"create-a-new-study"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["study"]}," The study that needs to be created."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request POST ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/studies' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '["," ","{"," ","\"title\": \"Robin Field Development\","," ","\"description\": \"New development opportunity.\","," ","\"workflowSpecId\": \"01CP3E6EJJ25J29YHZ0K4RDZH8\","," ","\"workflowSpecVersion\": 1,"," ","\"legalTags\": ["," ","\"legal-tag\""," ","],"," ","\"studyManagers\": ["," ","\"study-manager\""," ","],"," ","\"acl\": {"," ","\"owners\": ["," ","\"data.team-id-a.owners@tenant-id-1.entitlements-domain-1\","," ","\"data.team-id-b.owners@tenant-id-1.entitlements-domain-1\""," ","],"," ","\"viewers\": ["," ","\"data.team-id-a.viewers@tenant-id-1.entitlements-domain-1\","," ","\"data.team-id-b.viewers@tenant-id-1.entitlements-domain-1\""," ","]"," ","}"," ","}"," ","]'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 201"," ","{"," ","\"id\": \"01CP3E6EJJ25J29YHZ0K4RDZH8\","," ","\"title\": \"Robin Field Development\","," ","\"description\": \"New development opportunity.\","," ","\"country\": \"US\","," ","\"isArchived\": false,"," ","\"noOfRealizations\": 10,"," ","\"uncertaintyMethod\": \"MonteCarlo\","," ","\"workflowSpec\": {"," ","\"id\": \"01FDYW0CS3ZZB1FS2NCK01WVDX\","," ","\"version\": 1"," ","},"," ","\"acl\": {"," ","\"owners\": ["," ","\"data.team-id-a.owners@tenant-id-1.entitlements-domain-1\","," ","\"data.team-id-b.owners@tenant-id-1.entitlements-domain-1\""," ","],"," ","\"viewers\": ["," ","\"data.team-id-a.viewers@tenant-id-1.entitlements-domain-1\","," ","\"data.team-id-b.viewers@tenant-id-1.entitlements-domain-1\""," ","]"," ","}"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-a-study","__idx":6},"children":["Get a study ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-a-study"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get a study given a study ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study to get."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/studies/{studyId}' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"id\": \"01CP3E6EJJ25J29YHZ0K4RDZH8\","," ","\"title\": \"Robin Field Development\","," ","\"country\": \"US\","," ","\"isArchived\": false,"," ","\"noOfRealizations\": 10,"," ","\"uncertaintyMethod\": \"MonteCarlo\","," ","\"workflowSpec\": {"," ","\"id\": \"01FDYW0CS3GYWBH7S080PMJ66F\","," ","\"version\": 1"," ","},"," ","\"acl\": {"," ","\"owners\": ["," ","\"data.team-id-a.owners@tenant-id-1.entitlements-domain-1\","," ","\"data.team-id-b.owners@tenant-id-1.entitlements-domain-1\""," ","],"," ","\"viewers\": ["," ","\"data.team-id-a.viewers@tenant-id-1.entitlements-domain-1\","," ","\"data.team-id-b.viewers@tenant-id-1.entitlements-domain-1\""," ","]"," ","}"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"delete-a-study","__idx":7},"children":["Delete a study. ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"delete-a-study"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study to delete."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request DELETE ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/studies/{studyId}' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 401"," ","{"," ","\"data\": {"," ","\"code\": 500,"," ","\"message\": \"internal server error\""," ","}"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"update-a-study","__idx":8},"children":["Update a study. ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"update-a-study"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study to be updated."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["patches"]}," The patches to apply to the study. Only \"replace\" operation is supported."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request PATCH ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/studies/{studyId}' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '["," ","{"," ","\"op\": \"replace\","," ","\"path\": \"title\","," ","\"value\": \"title\""," ","},"," ","{"," ","\"op\": \"replace\","," ","\"path\": \"description\","," ","\"value\": \"description\""," ","}"," ","]'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"id\": \"01CP3E6EJJ25J29YHZ0K4RDZH8\","," ","\"title\": \"Robin Field Development\","," ","\"description\": \"New development opportunity.\","," ","\"country\": \"US\","," ","\"isArchived\": false,"," ","\"noOfRealizations\": 10,"," ","\"uncertaintyMethod\": \"MonteCarlo\","," ","\"workflowSpec\": {"," ","\"id\": \"01FDYW0CS3ZZB1FS2NCK01WVDX\","," ","\"version\": 1"," ","},"," ","\"acl\": {"," ","\"owners\": ["," ","\"data.team-id-a.owners@tenant-id-1.entitlements-domain-1\","," ","\"data.team-id-b.owners@tenant-id-1.entitlements-domain-1\""," ","],"," ","\"viewers\": ["," ","\"data.team-id-a.viewers@tenant-id-1.entitlements-domain-1\","," ","\"data.team-id-b.viewers@tenant-id-1.entitlements-domain-1\""," ","]"," ","}"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-all-kpos","__idx":9},"children":["Get all KPOs ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-all-kpos"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the list of Key Performance Objectives (KPOs)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study which KPOs belongs to."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/kpos?studyId=value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","["," ","{"," ","\"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$\""," ","}"," ","]"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-all-scenarios","__idx":10},"children":["Get all scenarios ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-all-scenarios"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get all scenarios including their associated Decisions/Choices."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study which Scenarios/Decisions/Choices belongs to."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/scenarios?studyId=value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","["," ","{"," ","\"id\": \"01CP3E6EJJ25J29YHZ0K4RDZH8\","," ","\"displayID\": \"S1\","," ","\"title\": \"Minimal investment\","," ","\"description\": \"Minimal investment development option scenario.\","," ","\"lastUpdated\": {"," ","\"atDate\": \"2020-09-08T09:53:36.000Z\","," ","\"byEvent\": \"01EHPJ54HEA77K95T5KPH5JSW9\","," ","\"byUser\": \"user@slb.com\""," ","},"," ","\"created\": {"," ","\"atDate\": \"2020-09-08T09:53:36.000Z\","," ","\"byEvent\": \"01EHPJ54HEA77K95T5KPH5JSW9\","," ","\"byUser\": \"user@slb.com\""," ","},"," ","\"isSelected\": false,"," ","\"colour\": \"#ff0000\","," ","\"associatedDevelopmentConceptId\": \"01CP3E6EJJ25J29YHZ0K4ANIH8\""," ","},"," ","{"," ","\"id\": \"01CP3E6EJJ25J29YHZ0K4RSDFI4\","," ","\"displayID\": \"S2\","," ","\"title\": \"Maximum investment\","," ","\"description\": \"Maximum investment development option scenario.\","," ","\"lastUpdated\": {"," ","\"atDate\": \"2020-09-08T09:53:36.000Z\","," ","\"byEvent\": \"01EHPJ54HEA77K95T5KPH5JSW9\","," ","\"byUser\": \"user@slb.com\""," ","},"," ","\"created\": {"," ","\"atDate\": \"2020-09-08T09:53:36.000Z\","," ","\"byEvent\": \"01EHPJ54HEA77K95T5KPH5JSW9\","," ","\"byUser\": \"user@slb.com\""," ","},"," ","\"isSelected\": false,"," ","\"colour\": \"#ff0000\","," ","\"associatedDevelopmentConceptId\": \"01CP3E6EJJ25J29YHZ0K4ANIH8\""," ","}"," ","]"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"create-a-new-scenario","__idx":11},"children":["Create a new scenario ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"create-a-new-scenario"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study in which scenario will be created."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["scenario"]}," The scenario that needs to be created."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request POST ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/scenarios?studyId=value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '{"," ","\"title\": \"Minimal investment\","," ","\"colour\": \"#ff0000\","," ","\"description\": \"Minimal investment development option scenario.\","," ","\"isSelected\": false,"," ","\"associatedOpportunityIDs\": ["," ","\"01CP3E6EJJ25J29YHZ0K4ANABC\","," ","\"01CP3E6EJJ25J29YHZ0K4ANDEF\""," ","]"," ","}'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 201"," ","{"," ","\"id\": \"01CP3E6EJJ25J29YHZ0K4RDZH8\","," ","\"displayID\": \"S1\","," ","\"title\": \"Minimal investment\","," ","\"description\": \"Minimal investment development option scenario.\","," ","\"lastUpdated\": {"," ","\"atDate\": \"2020-09-08T09:53:36.000Z\","," ","\"byEvent\": \"01EHPJ54HEA77K95T5KPH5JSW9\","," ","\"byUser\": \"user@slb.com\""," ","},"," ","\"created\": {"," ","\"atDate\": \"2020-09-08T09:53:36.000Z\","," ","\"byEvent\": \"01EHPJ54HEA77K95T5KPH5JSW9\","," ","\"byUser\": \"user@slb.com\""," ","},"," ","\"isSelected\": false,"," ","\"colour\": \"#ff0000\","," ","\"version\": 2,"," ","\"associatedDevelopmentConceptId\": \"01CP3E6EJJ25J29YHZ0K4ANIH8\","," ","\"associatedOpportunityIDs\": ["," ","\"01CP3E6EJJ25J29YHZ0K4ANABC\","," ","\"01CP3E6EJJ25J29YHZ0K4ANDEF\""," ","]"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"delete-a-scenario","__idx":12},"children":["Delete a scenario ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"delete-a-scenario"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Delete a scenario in a given study given scenario ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study to which the scenario belongs."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["scenarioId"]}," The id of the scenario to delete."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request DELETE ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/scenarios?scenarioId=value&studyId=value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 400"," ","{"," ","\"data\": {"," ","\"code\": 500,"," ","\"message\": \"internal server error\""," ","}"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"update-a-scenario","__idx":13},"children":["Update a scenario ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"update-a-scenario"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Update an existing scenario. It is possible to update the title, description, displayID, colour and isSelected scenario fields."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study id which the scenario belong to."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["scenarioId"]}," The id of the scenario to update."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["patches"]}," The patches to apply to the scenario. Only \"replace\" operation is supported."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request PATCH ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/scenarios?scenarioId=value&studyId=value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '["," ","{"," ","\"op\": \"replace\","," ","\"path\": \"title\","," ","\"value\": \"title\""," ","},"," ","{"," ","\"op\": \"replace\","," ","\"path\": \"description\","," ","\"value\": \"description\""," ","}"," ","]'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"id\": \"01CP3E6EJJ25J29YHZ0K4RDZH8\","," ","\"displayID\": \"S1\","," ","\"title\": \"Minimal investment\","," ","\"description\": \"Minimal investment development option scenario.\","," ","\"lastUpdated\": {"," ","\"atDate\": \"2020-09-08T09:53:36.000Z\","," ","\"byEvent\": \"01EHPJ54HEA77K95T5KPH5JSW9\","," ","\"byUser\": \"user@slb.com\""," ","},"," ","\"created\": {"," ","\"atDate\": \"2020-09-08T09:53:36.000Z\","," ","\"byEvent\": \"01EHPJ54HEA77K95T5KPH5JSW9\","," ","\"byUser\": \"user@slb.com\""," ","},"," ","\"isSelected\": false,"," ","\"colour\": \"#ff0000\","," ","\"version\": 2,"," ","\"associatedDevelopmentConceptId\": \"01CP3E6EJJ25J29YHZ0K4ANIH8\","," ","\"associatedOpportunityIDs\": ["," ","\"01CP3E6EJJ25J29YHZ0K4ANABC\","," ","\"01CP3E6EJJ25J29YHZ0K4ANDEF\""," ","]"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-scenario-results-state","__idx":14},"children":["Get scenario results state ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-scenario-results-state"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the scenario result state."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study from which to get the results state."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["scenarioId"]}," The scenario from which to get the results state."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/scenarios/results-state?scenarioId=value&studyId=value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"dataSource\": {"," ","\"id\": \"01EY46YV3JXND9NM0T70HABRXF\","," ","\"version\": 1"," ","},"," ","\"dataSourceProcessingErrors\": ["," ","],"," ","\"dataSourceProcessingState\": \"CompletedSuccessfully\","," ","\"lastUpdated\": \"2021-02-09T20:56:46.000Z\","," ","\"realizationStates\": {"," ","\"uri\": \"01HGWMW4HWETWWFZCA1Z0C453Z/realizations/01HGWQMY95XHSCDKSBYRZ8P67M\","," ","\"computationStates\": ["," ","{"," ","\"address\": {"," ","\"computationIndex\": 0,"," ","\"dataTypeIndex\": 0,"," ","\"type\": \"Computation\""," ","},"," ","\"runState\": \"CompletedSuccessfully\""," ","},"," ","{"," ","\"address\": {"," ","\"computationIndex\": 1,"," ","\"dataTypeIndex\": 0,"," ","\"type\": \"Computation\""," ","},"," ","\"runState\": \"CompletedSuccessfully\""," ","}"," ","],"," ","\"lastUpdatedAt\": \"2021-02-09T20:53:55.000Z\","," ","\"resultsErrors\": ["," ","],"," ","\"state\": \"CompletedSuccessfully\","," ","\"version\": 11"," ","},"," ","\"resultsPublishingErrors\": ["," ","],"," ","\"resultsPublishingState\": \"CompletedSuccessfully\""," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-all-deliverables","__idx":15},"children":["Get all deliverables ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-all-deliverables"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get all deliverables."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study which the deliverables belong to."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["scenarioId"]}," The optional scenario which the deliverables belong to. If not specified all deliverables for given study will be returned."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/deliverables?studyId=value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","["," ","{"," ","\"id\": \"01CKXHZPAEERP06F3CNKBAPE0F\","," ","\"title\": 1,"," ","\"description\": \"Decline curves for Robin field.\","," ","\"status\": \"Requested\","," ","\"attachmentType\": \"decline-curves\","," ","\"attachmentTypeVersion\": 1"," ","},"," ","{"," ","\"id\": \"01CKXHZPAEERP06F3SDFKJ567F\","," ","\"title\": 1,"," ","\"description\": \"Facility Constraints for Robin field.\","," ","\"status\": \"Requested\","," ","\"attachmentType\": \"facility-constraints\","," ","\"attachmentTypeVersion\": 1"," ","}"," ","]"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-a-deliverable","__idx":16},"children":["Get a deliverable ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-a-deliverable"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get a deliverable given a deliverable ID."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study which the deliverable belongs to."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["deliverableId"]}," The ID of the deliverable to get."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/deliverables/{deliverableId}?studyId=value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"id\": \"01CKXHZPAEERP06F3CNKBAPE0F\","," ","\"title\": 1,"," ","\"description\": \"Decline curves for Robin field.\","," ","\"status\": \"Requested\","," ","\"attachmentType\": \"decline-curves\","," ","\"attachmentTypeVersion\": 1"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"update-a-deliverable","__idx":17},"children":["Update a deliverable ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"update-a-deliverable"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Update an existing deliverable. It is possible to update the title, description, owner, contributers, approvers, due date, status, comments and data source deliverable fields."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study which the deliverable belong to."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["deliverableId"]}," The ID of the deliverable to update."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["patches"]}," The patches to apply to the deliverable. Only \"replace\" and \"remove\" operations are supported. The \"remove\" operation is only supported for the \"dataSource\" path."]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request PATCH ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/deliverables/{deliverableId}?studyId=value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--data '["," ","{"," ","\"op\": \"replace\","," ","\"path\": \"title\","," ","\"value\": \"title\""," ","},"," ","{"," ","\"op\": \"replace\","," ","\"path\": \"description\","," ","\"value\": \"description\""," ","}"," ","]'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"," ","{"," ","\"id\": \"01CKXHZPAEERP06F3CNKBAPE0F\","," ","\"title\": \"title\","," ","\"description\": \"description\","," ","\"status\": \"Requested\","," ","\"attachmentType\": \"decline-curves\","," ","\"attachmentTypeVersion\": 1"," ","}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-the-list-of-opportunities-for-the-given-study","__idx":18},"children":["Get the list of opportunities for the given study. ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-the-list-of-opportunities-for-the-given-study"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The study"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pageNumber"]}," The number of the page in the list of Opportunities"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pageSize"]}," The number of Opportunities per page"]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/opportunities?studyId=value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-ranking-scores-for-the-scenarios-in-the-given-study-id","__idx":19},"children":["Get ranking scores for the scenarios in the given study ID ",{"$$mdtype":"Tag","name":"a","attributes":{"name":"get-ranking-scores-for-the-scenarios-in-the-given-study-id"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameters"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["slb-data-partition-id"]}," Data partition id."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["studyId"]}," The ID of the study for which to get the scenario ranking scores"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pageNumber"]}," The number of the page in the list of ranking scores."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pageSize"]}," The number of ranking scores per page."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["includeCriteriaScores"]}," Whether to include criteria scores break-down in the response"]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"b","attributes":{},"children":["Example"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["curl -request GET ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--url 'https://api.delfi.slb.com/fdplan/studies/v1/scenario-ranking-scores?studyId=value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'Authorization: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'appkey: value' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'content-type: application/json' ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"--header 'slb-data-partition-id: header'"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Response: 200"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#toc"},"children":["Back to table of contents"]}]}]},"headings":[{"value":"Studies","id":"studies","depth":1},{"value":"Table of contents","id":"table-of-contents","depth":1},{"value":"Get the list of Key Performance Indicators (KPIs).","id":"get-the-list-of-key-performance-indicators-kpis","depth":1},{"value":"Update an existing Key Performance Indicator (KPI) or create a new one.","id":"update-an-existing-key-performance-indicator-kpi-or-create-a-new-one","depth":1},{"value":"Get all studies","id":"get-all-studies","depth":1},{"value":"Create a new study","id":"create-a-new-study","depth":1},{"value":"Get a study","id":"get-a-study","depth":1},{"value":"Delete a study.","id":"delete-a-study","depth":1},{"value":"Update a study.","id":"update-a-study","depth":1},{"value":"Get all KPOs","id":"get-all-kpos","depth":1},{"value":"Get all scenarios","id":"get-all-scenarios","depth":1},{"value":"Create a new scenario","id":"create-a-new-scenario","depth":1},{"value":"Delete a scenario","id":"delete-a-scenario","depth":1},{"value":"Update a scenario","id":"update-a-scenario","depth":1},{"value":"Get scenario results state","id":"get-scenario-results-state","depth":1},{"value":"Get all deliverables","id":"get-all-deliverables","depth":1},{"value":"Get a deliverable","id":"get-a-deliverable","depth":1},{"value":"Update a deliverable","id":"update-a-deliverable","depth":1},{"value":"Get the list of opportunities for the given study.","id":"get-the-list-of-opportunities-for-the-given-study","depth":1},{"value":"Get ranking scores for the scenarios in the given study ID","id":"get-ranking-scores-for-the-scenarios-in-the-given-study-id","depth":1}],"frontmatter":{"seo":{"title":"Studies"}},"lastModified":"2025-04-08T15:57:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/fdplan/tutorial/studies-openapi_nam","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}