{"items":[{"type":"link","label":"Studies","link":"/solutions/fdplan/apis/fdplan-studies","routeSlug":"/solutions/fdplan/apis/fdplan-studies","content":{"contentType":"overview","meta":{"name":"Studies"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"Studies Spec","url":"https://developer.slb.com/fdplan/FDPlan-Studies.yaml"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://customersupport.digital.slb.com","url":"https://customersupport.digital.slb.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Studies (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"fence","attributes":{"content":"prod-nam-services-fdplan.slbservice.com\nprod-eu-services-fdplan.slbservice.com\nprod-au-services-fdplan.slbservice.com\nprod-id-services-fdplan.slbservice.com\nproduction-services-fdplan.slbservice.com\n","language":"plain","title":"Client ID"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"prod-nam-services-fdplan.slbservice.com\nprod-eu-services-fdplan.slbservice.com\nprod-au-services-fdplan.slbservice.com\nprod-id-services-fdplan.slbservice.com\nproduction-services-fdplan.slbservice.com\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The studies API is responsible for study data within FDPlan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key API concepts include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"studies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A study covers the allocation of time and resources to gain"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"knowledge of an asset, identify potential opportunities and threats,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"derive and evaluate candidate development scenarios, and make critical"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decisions in field-development planning. It can also be referred to as an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"asset evaluation project or a conceptual field-development planning"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"project. You can have several studies for different stages of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field-development planning, such as one study for the appraisal stage and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"another for the concept selection stage."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KPOs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A key performance objective (KPO) is an objective that is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"critical to the success of the project. Typically, three to five"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"objectives are identified as key objectives."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KPIs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A key performance indicator (KPI) represents the performance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the current development scenario compared with the key performance"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"objective, for example, net present value (NPV),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"internal rate of return (IRR), payback period, date of first oil,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"maximum exposure, and proven reserves."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decisions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A decision must be made or has been made to define the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field-development plan. It can contain one or more available choices to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"select. A decision is made when one of the available choices is selected."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"choices"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A choice is an option you can choose to make a decision. It"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can also be referred to as a concept. There can be multiple available"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"choices in making a decision. A choice can be available or unavailable,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and can be selected or unselected."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scenarios"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A scenario is a combination of development choices that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"describes a particular way to develop a field. It can also be referred to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as a development scenario, a concept, or a development option."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deliverables"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A deliverable is a work item in which you can manage the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"life cycle of the required data or the documents for a study. It holds the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information on the status of the domain contribution, the contributors,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the approvers, and the due date. A contribution that fulfills a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deliverable is referred to as an 'data source'."},"children":[]}]}]}]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Kpis","link":"/solutions/fdplan/apis/fdplan-studies/kpis","routeSlug":"/solutions/fdplan/apis/fdplan-studies/kpis","items":[{"label":"Get the list of Key Performance Indicators (KPIs).","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/kpis/getkpis","routeSlug":"/solutions/fdplan/apis/fdplan-studies/kpis/getkpis","metadata":{"seo":{"title":"Get the list of Key Performance Indicators (KPIs).","description":"Returns the tenant-wide catalog of Key Performance Indicators (KPIs) - the reusable metrics such as NPV, IRR, payback period, or first-oil date that studies target through their KPOs. The catalog includes both built-in system KPIs and any custom KPIs registered for the partition, and is paginated with the pageNumber and pageSize parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKpis","name":"Get the list of Key Performance Indicators (KPIs).","isWebhook":false,"pointer":"/paths/~1v1~1kpis/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the list of Key Performance Indicators (KPIs).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the tenant-wide catalog of Key Performance Indicators (KPIs) -\nthe reusable metrics such as NPV, IRR, payback period, or first-oil date\nthat studies target through their KPOs. The catalog includes both\nbuilt-in system KPIs and any custom KPIs registered for the partition,\nand is paginated with the pageNumber and pageSize parameters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_0","description":"The number of the page in the list of KPIs"},{"name":"pageSize","in":"query","schemaId":"schema_1","description":"The number of KPIs per page"}],"pointer":"/paths/~1v1~1kpis/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1kpis/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/kpis","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pageNumber","in":"query","schemaId":"schema_0"},{"name":"pageSize","in":"query","schemaId":"schema_1"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","204","400","401","503","default"],"pointer":"/v1/kpis","href":"kpis/getkpis","openApiOperationId":"getKpis","summary":"Get the list of Key Performance Indicators (KPIs)."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KpiCollection"}},"schemaId":"components/schemas/KpiCollection"},{"code":"204","description":"Success."},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1kpis/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KpiCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KpiCollection"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kpis/getkpis"}],"panels":[]}]},"httpPath":"/v1/kpis"},{"label":"Update an existing Key Performance Indicator (KPI) or create a new one.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/kpis/putkpi","routeSlug":"/solutions/fdplan/apis/fdplan-studies/kpis/putkpi","metadata":{"seo":{"title":"Update an existing Key Performance Indicator (KPI) or create a new one.","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putKpi","name":"Update an existing Key Performance Indicator (KPI) or create a new one.","isWebhook":false,"pointer":"/paths/~1v1~1kpis~1{kpiName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an existing Key Performance Indicator (KPI) or create a new one.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Registers a new custom Key Performance Indicator (KPI) or updates an\nexisting one, identified by its immutable kpiName. Use this to extend the\npartition catalog with metrics beyond the built-in system KPIs. Returns\n201 when a KPI is created and 200 when an existing one is updated;\nbuilt-in system KPIs cannot be modified.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"kpiName","in":"path","schemaId":"schema_3","description":"The name of the KPI to update or create.","required":true}],"pointer":"/paths/~1v1~1kpis~1{kpiName}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1kpis~1{kpiName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateKpiRequest"}},"schemaId":"components/schemas/CreateKpiRequest","pointer":"/paths/~1v1~1kpis~1{kpiName}/put/requestBody","description":"The KPI details to update or create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/kpis/{kpiName}","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"kpiName","in":"path","required":true,"schemaId":"schema_3"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateKpiRequest"}},"responseCodes":["200","201","400","401","default"],"pointer":"/v1/kpis/{kpiName}","href":"kpis/putkpi","openApiOperationId":"putKpi","summary":"Update an existing Key Performance Indicator (KPI) or create a new one."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateKpiRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateKpiRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The KPI was updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Kpi"}},"schemaId":"components/schemas/Kpi"},{"code":"201","description":"The KPI was created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Kpi"}},"schemaId":"components/schemas/Kpi"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1kpis~1{kpiName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Kpi","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Kpi"}}},{"code":"201","schemaId":"components/schemas/Kpi","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Kpi"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kpis/putkpi"}],"panels":[]}]},"httpPath":"/v1/kpis/{kpiName}"}],"content":{"contentType":"group","meta":{"name":"Kpis"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Kpis","showPageActions":true},{"nodeType":"markdoc","content":"Manage Key Performance Indicators (KPIs)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/kpis","summary":"Get the list of Key Performance Indicators (KPIs).","prefix":{"name":"get","color":"get"},"badges":[],"link":"/kpis/getkpis","deprecated":false},{"title":"/v1/kpis/{kpiName}","summary":"Update an existing Key Performance Indicator (KPI) or create a new one.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/kpis/putkpi","deprecated":false}]}]}]}]}},{"type":"group","label":"Studies","link":"/solutions/fdplan/apis/fdplan-studies/studies","routeSlug":"/solutions/fdplan/apis/fdplan-studies/studies","items":[{"label":"Get all studies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/studies/getstudies","routeSlug":"/solutions/fdplan/apis/fdplan-studies/studies/getstudies","metadata":{"seo":{"title":"Get all studies","description":"Returns all studies visible to the caller in the current partition."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStudies","name":"Get all studies","isWebhook":false,"pointer":"/paths/~1v1~1studies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all studies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all studies visible to the caller in the current partition.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1studies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/studies","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","204","401","503","default"],"pointer":"/v1/studies","href":"studies/getstudies","openApiOperationId":"getStudies","summary":"Get all studies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Retrieved studies successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Studies"}},"schemaId":"components/schemas/Studies"},{"code":"204","description":"No studies were found."},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1studies/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Studies","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Studies"}}},{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/studies/getstudies"}],"panels":[]}]},"httpPath":"/v1/studies"},{"label":"Create a new study","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/studies/poststudy","routeSlug":"/solutions/fdplan/apis/fdplan-studies/studies/poststudy","metadata":{"seo":{"title":"Create a new study","description":"Creates a new study for an investment opportunity, specifying the evaluation workflow specification and the access control groups that govern it. The returned study ID becomes the correlation key that ties every downstream scenario, deliverable, and result back to this study."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postStudy","name":"Create a new study","isWebhook":false,"pointer":"/paths/~1v1~1studies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new study","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new study for an investment opportunity, specifying the\nevaluation workflow specification and the access control groups that\ngovern it. The returned study ID becomes the correlation key that ties\nevery downstream scenario, deliverable, and result back to this study.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1studies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateStudyRequest"}},"schemaId":"components/schemas/CreateStudyRequest","pointer":"/paths/~1v1~1studies/post/requestBody","description":"The study that needs to be created."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/studies","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateStudyRequest"}},"responseCodes":["201","400","451","503","default"],"pointer":"/v1/studies","href":"studies/poststudy","openApiOperationId":"postStudy","summary":"Create a new study"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateStudyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateStudyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Study created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Study"}},"schemaId":"components/schemas/Study","headers":{"Location":{"description":"The URL of the created study.","x-nullable":false,"schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"One or more Legal Tags are invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1studies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Study","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Study"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/studies/poststudy"}],"panels":[]}]},"httpPath":"/v1/studies"}],"content":{"contentType":"group","meta":{"name":"Studies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Studies","showPageActions":true},{"nodeType":"markdoc","content":"Manage studies."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/studies","summary":"Get all studies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/studies/getstudies","deprecated":false},{"title":"/v1/studies","summary":"Create a new study","prefix":{"name":"post","color":"post"},"badges":[],"link":"/studies/poststudy","deprecated":false}]}]}]}]}},{"type":"group","label":"Study","link":"/solutions/fdplan/apis/fdplan-studies/study","routeSlug":"/solutions/fdplan/apis/fdplan-studies/study","items":[{"label":"Get a study","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/study/getstudy","routeSlug":"/solutions/fdplan/apis/fdplan-studies/study/getstudy","metadata":{"seo":{"title":"Get a study","description":"Returns the full detail of a single study identified by its study ID, including its workflow specification, uncertainty settings, legal tags, and audit metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStudy","name":"Get a study","isWebhook":false,"pointer":"/paths/~1v1~1studies~1{studyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a study","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the full detail of a single study identified by its study ID,\nincluding its workflow specification, uncertainty settings, legal tags,\nand audit metadata.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"studyId","in":"path","schemaId":"schema_2","description":"The study to get.","required":true}],"pointer":"/paths/~1v1~1studies~1{studyId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1studies~1{studyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/studies/{studyId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"studyId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","451","503","default"],"pointer":"/v1/studies/{studyId}","href":"study/getstudy","openApiOperationId":"getStudy","summary":"Get a study"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Study retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StudyDetail"}},"schemaId":"components/schemas/StudyDetail","headers":{"Last-Modified":{"description":"Date-time of when the study was last updated","x-nullable":false,"schema":{"type":"string"}}},"headerSchemaId":"schema_5"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The study was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1studies~1{studyId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StudyDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StudyDetail"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/study/getstudy"}],"panels":[]}]},"httpPath":"/v1/studies/{studyId}"},{"label":"Delete a study.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/study/deletestudy","routeSlug":"/solutions/fdplan/apis/fdplan-studies/study/deletestudy","metadata":{"seo":{"title":"Delete a study.","description":"Permanently deletes the study identified by its study ID, along with the scenarios, deliverables, and results correlated with it. This action cannot be undone."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteStudy","name":"Delete a study.","isWebhook":false,"pointer":"/paths/~1v1~1studies~1{studyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a study.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently deletes the study identified by its study ID, along with the\nscenarios, deliverables, and results correlated with it. This action\ncannot be undone.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"studyId","in":"path","schemaId":"schema_2","description":"The study to delete.","required":true}],"pointer":"/paths/~1v1~1studies~1{studyId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1studies~1{studyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/studies/{studyId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"studyId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["204","401","404","503","default"],"pointer":"/v1/studies/{studyId}","href":"study/deletestudy","openApiOperationId":"deleteStudy","summary":"Delete a study."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success."},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The study was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1studies~1{studyId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/study/deletestudy"}],"panels":[]}]},"httpPath":"/v1/studies/{studyId}"},{"label":"Update a study.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/study/patchstudy","routeSlug":"/solutions/fdplan/apis/fdplan-studies/study/patchstudy","metadata":{"seo":{"title":"Update a study.","description":"Applies partial updates to an existing study using JSON-Patch replace operations, for example to change its title, description, or uncertainty configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchStudy","name":"Update a study.","isWebhook":false,"pointer":"/paths/~1v1~1studies~1{studyId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a study.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Applies partial updates to an existing study using JSON-Patch replace\noperations, for example to change its title, description, or uncertainty\nconfiguration.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"studyId","in":"path","schemaId":"schema_2","description":"The study to be updated.","required":true}],"pointer":"/paths/~1v1~1studies~1{studyId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1studies~1{studyId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"schemaId":"components/schemas/PatchReq","pointer":"/paths/~1v1~1studies~1{studyId}/patch/requestBody","description":"The patches to apply to the study. Only \"replace\" operation is supported."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/studies/{studyId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"studyId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"responseCodes":["200","400","401","404","451","503","default"],"pointer":"/v1/studies/{studyId}","href":"study/patchstudy","openApiOperationId":"patchStudy","summary":"Update a study."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/PatchReq","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Study updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Study"}},"schemaId":"components/schemas/Study"},{"code":"400","description":"The supplied study information is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The study was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"The study is not legally compliant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NonCompliantStudy"}},"schemaId":"components/schemas/NonCompliantStudy"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1studies~1{studyId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Study","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Study"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/NonCompliantStudy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NonCompliantStudy"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/study/patchstudy"}],"panels":[]}]},"httpPath":"/v1/studies/{studyId}"}],"content":{"contentType":"group","meta":{"name":"Study"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Study","showPageActions":true},{"nodeType":"markdoc","content":"Manage individual studies."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/studies/{studyId}","summary":"Get a study","prefix":{"name":"get","color":"get"},"badges":[],"link":"/study/getstudy","deprecated":false},{"title":"/v1/studies/{studyId}","summary":"Delete a study.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/study/deletestudy","deprecated":false},{"title":"/v1/studies/{studyId}","summary":"Update a study.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/study/patchstudy","deprecated":false}]}]}]}]}},{"type":"group","label":"kpos","link":"/solutions/fdplan/apis/fdplan-studies/kpos","routeSlug":"/solutions/fdplan/apis/fdplan-studies/kpos","items":[{"label":"Get all KPOs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/kpos/getkpos","routeSlug":"/solutions/fdplan/apis/fdplan-studies/kpos/getkpos","metadata":{"seo":{"title":"Get all KPOs","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKpos","name":"Get all KPOs","isWebhook":false,"pointer":"/paths/~1v1~1kpos/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all KPOs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the Key Performance Objectives (KPOs) defined for the given\nstudy - the per-study targets that bind a referenced KPI to an objective\noperator and threshold value used to judge scenario success. Requires the\nstudyId of the study whose objectives are being read.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"studyId","in":"query","schemaId":"schema_2","description":"The study which KPOs belongs to.","required":true}],"pointer":"/paths/~1v1~1kpos/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1kpos/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/kpos","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"studyId","in":"query","required":true,"schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","204","401","404","451","503","default"],"pointer":"/v1/kpos","href":"kpos/getkpos","openApiOperationId":"getKpos","summary":"Get all KPOs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Retrieved KPOs successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KpoCollection"}},"schemaId":"components/schemas/KpoCollection"},{"code":"204","description":"No KPOs in the study were found."},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The study was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1kpos/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/KpoCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/KpoCollection"}}},{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kpos/getkpos"}],"panels":[]}]},"httpPath":"/v1/kpos"}],"content":{"contentType":"group","meta":{"name":"kpos"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"kpos","showPageActions":true},{"nodeType":"markdoc","content":"Manage Key Performance Objectives (KPOs)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/kpos","summary":"Get all KPOs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/kpos/getkpos","deprecated":false}]}]}]}]}},{"type":"group","label":"Scenarios","link":"/solutions/fdplan/apis/fdplan-studies/scenarios","routeSlug":"/solutions/fdplan/apis/fdplan-studies/scenarios","items":[{"label":"Get all scenarios","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/scenarios/getscenarios","routeSlug":"/solutions/fdplan/apis/fdplan-studies/scenarios/getscenarios","metadata":{"seo":{"title":"Get all scenarios","description":"Returns all scenarios in the given study, each with its answered decisions and the choice selected for that scenario. A scenario represents one candidate development option evaluated against the study's workflow specification. Requires the studyId of the owning study."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getScenarios","name":"Get all scenarios","isWebhook":false,"pointer":"/paths/~1v1~1scenarios/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all scenarios","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all scenarios in the given study, each with its answered\ndecisions and the choice selected for that scenario. A scenario\nrepresents one candidate development option evaluated against the study's\nworkflow specification. Requires the studyId of the owning study.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"studyId","in":"query","schemaId":"schema_2","description":"The study which Scenarios/Decisions/Choices belongs to.","required":true}],"pointer":"/paths/~1v1~1scenarios/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1scenarios/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/scenarios","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"studyId","in":"query","required":true,"schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","451","503","default"],"pointer":"/v1/scenarios","href":"scenarios/getscenarios","openApiOperationId":"getScenarios","summary":"Get all scenarios"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Retrieved scenarios successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Scenarios"}},"schemaId":"components/schemas/Scenarios"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The study was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1scenarios/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Scenarios","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Scenarios"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scenarios/getscenarios"}],"panels":[]}]},"httpPath":"/v1/scenarios"},{"label":"Create a new scenario","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/scenarios/postscenario","routeSlug":"/solutions/fdplan/apis/fdplan-studies/scenarios/postscenario","metadata":{"seo":{"title":"Create a new scenario","description":"Creates a new scenario in the given study as a candidate development option. An ensemble to hold the scenario's realizations is provisioned automatically; only the scenario title is required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postScenario","name":"Create a new scenario","isWebhook":false,"pointer":"/paths/~1v1~1scenarios/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new scenario","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new scenario in the given study as a candidate development\noption. An ensemble to hold the scenario's realizations is provisioned\nautomatically; only the scenario title is required.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"studyId","in":"query","schemaId":"schema_2","description":"The study in which scenario will be created.","required":true}],"pointer":"/paths/~1v1~1scenarios/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1scenarios/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateScenarioRequest"}},"schemaId":"components/schemas/CreateScenarioRequest","pointer":"/paths/~1v1~1scenarios/post/requestBody","description":"The scenario that needs to be created."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/scenarios","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"studyId","in":"query","required":true,"schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateScenarioRequest"}},"responseCodes":["201","400","401","404","409","451","503","default"],"pointer":"/v1/scenarios","href":"scenarios/postscenario","openApiOperationId":"postScenario","summary":"Create a new scenario"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CreateScenarioRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateScenarioRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Scenario created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Scenario"}},"schemaId":"components/schemas/Scenario","headers":{"Location":{"description":"The URL of the scenario.","x-nullable":false,"schema":{"type":"string"}}},"headerSchemaId":"schema_6"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The studyID was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1scenarios/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/Scenario","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Scenario"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scenarios/postscenario"}],"panels":[]}]},"httpPath":"/v1/scenarios"},{"label":"Delete a scenario","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/scenarios/deletescenario","routeSlug":"/solutions/fdplan/apis/fdplan-studies/scenarios/deletescenario","metadata":{"seo":{"title":"Delete a scenario","description":"Deletes the scenario identified by scenarioId from the given study, together with its ensemble and the results associated with it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteScenario","name":"Delete a scenario","isWebhook":false,"pointer":"/paths/~1v1~1scenarios/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a scenario","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the scenario identified by scenarioId from the given study,\ntogether with its ensemble and the results associated with it.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"studyId","in":"query","schemaId":"schema_2","description":"The study to which the scenario belongs.","required":true},{"name":"scenarioId","in":"query","schemaId":"schema_2","description":"The id of the scenario to delete.","required":true}],"pointer":"/paths/~1v1~1scenarios/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1scenarios/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/scenarios","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"studyId","in":"query","required":true,"schemaId":"schema_2"},{"name":"scenarioId","in":"query","required":true,"schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","404","503","default"],"pointer":"/v1/scenarios","href":"scenarios/deletescenario","openApiOperationId":"deleteScenario","summary":"Delete a scenario"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful deletion."},{"code":"400","description":"Invalid scenarioID or studyID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The scenario to delete does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1scenarios/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scenarios/deletescenario"}],"panels":[]}]},"httpPath":"/v1/scenarios"},{"label":"Update a scenario","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/scenarios/patchscenario","routeSlug":"/solutions/fdplan/apis/fdplan-studies/scenarios/patchscenario","metadata":{"seo":{"title":"Update a scenario","description":"Applies partial updates to an existing scenario using JSON-Patch replace operations. The title, description, displayID, colour, and isSelected fields can be updated; set isSelected to feature a scenario above the others in the same study."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchScenario","name":"Update a scenario","isWebhook":false,"pointer":"/paths/~1v1~1scenarios/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a scenario","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Applies partial updates to an existing scenario using JSON-Patch replace\noperations. The title, description, displayID, colour, and isSelected\nfields can be updated; set isSelected to feature a scenario above the\nothers in the same study.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"studyId","in":"query","schemaId":"schema_2","description":"The study id which the scenario belong to.","required":true},{"name":"scenarioId","in":"query","schemaId":"schema_2","description":"The id of the scenario to update.","required":true}],"pointer":"/paths/~1v1~1scenarios/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1scenarios/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"schemaId":"components/schemas/PatchReq","pointer":"/paths/~1v1~1scenarios/patch/requestBody","description":"The patches to apply to the scenario. Only \"replace\" operation is supported."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/scenarios","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"studyId","in":"query","required":true,"schemaId":"schema_2"},{"name":"scenarioId","in":"query","required":true,"schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"responseCodes":["200","400","401","404","451","503","default"],"pointer":"/v1/scenarios","href":"scenarios/patchscenario","openApiOperationId":"patchScenario","summary":"Update a scenario"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/PatchReq","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Scenario updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Scenario"}},"schemaId":"components/schemas/Scenario"},{"code":"400","description":"The supplied scenario information is invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The scenario was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1scenarios/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Scenario","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Scenario"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scenarios/patchscenario"}],"panels":[]}]},"httpPath":"/v1/scenarios"}],"content":{"contentType":"group","meta":{"name":"Scenarios"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scenarios","showPageActions":true},{"nodeType":"markdoc","content":"Manage scenarios."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/scenarios","summary":"Get all scenarios","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scenarios/getscenarios","deprecated":false},{"title":"/v1/scenarios","summary":"Create a new scenario","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scenarios/postscenario","deprecated":false},{"title":"/v1/scenarios","summary":"Delete a scenario","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/scenarios/deletescenario","deprecated":false},{"title":"/v1/scenarios","summary":"Update a scenario","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/scenarios/patchscenario","deprecated":false}]}]}]}]}},{"type":"group","label":"Results","link":"/solutions/fdplan/apis/fdplan-studies/results","routeSlug":"/solutions/fdplan/apis/fdplan-studies/results","items":[{"label":"Get scenario results state","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/results/getscenarioresultsstate","routeSlug":"/solutions/fdplan/apis/fdplan-studies/results/getscenarioresultsstate","metadata":{"seo":{"title":"Get scenario results state","description":"Returns the computed run state of a scenario - the data source processing and results publishing status of its ensemble, broken down per realization. Use this to track evaluation progress for the given studyId and scenarioId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getScenarioResultsState","name":"Get scenario results state","isWebhook":false,"pointer":"/paths/~1v1~1scenarios~1results-state/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get scenario results state","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the computed run state of a scenario - the data source\nprocessing and results publishing status of its ensemble, broken down per\nrealization. Use this to track evaluation progress for the given studyId\nand scenarioId.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"studyId","in":"query","schemaId":"schema_2","description":"The study from which to get the results state.","required":true},{"name":"scenarioId","in":"query","schemaId":"schema_2","description":"The scenario from which to get the results state.","required":true}],"pointer":"/paths/~1v1~1scenarios~1results-state/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1scenarios~1results-state/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/scenarios/results-state","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"studyId","in":"query","required":true,"schemaId":"schema_2"},{"name":"scenarioId","in":"query","required":true,"schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","451","503","default"],"pointer":"/v1/scenarios/results-state","href":"results/getscenarioresultsstate","openApiOperationId":"getScenarioResultsState","summary":"Get scenario results state"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScenarioResultsState"}},"schemaId":"components/schemas/ScenarioResultsState"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Either the studyId or the scenarioId was not found, or the scenario is not part of the study.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1scenarios~1results-state/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ScenarioResultsState","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ScenarioResultsState"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/results/getscenarioresultsstate"}],"panels":[]}]},"httpPath":"/v1/scenarios/results-state"}],"content":{"contentType":"group","meta":{"name":"Results"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Results","showPageActions":true},{"nodeType":"markdoc","content":"Manage results."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/scenarios/results-state","summary":"Get scenario results state","prefix":{"name":"get","color":"get"},"badges":[],"link":"/results/getscenarioresultsstate","deprecated":false}]}]}]}]}},{"type":"group","label":"Deliverables","link":"/solutions/fdplan/apis/fdplan-studies/deliverables","routeSlug":"/solutions/fdplan/apis/fdplan-studies/deliverables","items":[{"label":"Get all deliverables","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/deliverables/getdeliverables","routeSlug":"/solutions/fdplan/apis/fdplan-studies/deliverables/getdeliverables","metadata":{"seo":{"title":"Get all deliverables","description":"Returns the deliverables for the given study - the required input slots that must be fulfilled with data sources before a scenario can be evaluated. Optionally filter to a single scenario with scenarioId; otherwise all deliverables for the study are returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeliverables","name":"Get all deliverables","isWebhook":false,"pointer":"/paths/~1v1~1deliverables/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all deliverables","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the deliverables for the given study - the required input slots\nthat must be fulfilled with data sources before a scenario can be\nevaluated. Optionally filter to a single scenario with scenarioId;\notherwise all deliverables for the study are returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"studyId","in":"query","schemaId":"schema_2","description":"The study which the deliverables belong to.","required":true},{"name":"scenarioId","in":"query","schemaId":"schema_2","description":"The optional scenario which the deliverables belong to. If not specified all deliverables for given study will be returned."}],"pointer":"/paths/~1v1~1deliverables/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1deliverables/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/deliverables","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"studyId","in":"query","required":true,"schemaId":"schema_2"},{"name":"scenarioId","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","204","401","404","451","503","default"],"pointer":"/v1/deliverables","href":"deliverables/getdeliverables","openApiOperationId":"getDeliverables","summary":"Get all deliverables"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Retrieved deliverables successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Deliverables"}},"schemaId":"components/schemas/Deliverables"},{"code":"204","description":"No deliverables in the study were found."},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The study was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1deliverables/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Deliverables","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Deliverables"}}},{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deliverables/getdeliverables"}],"panels":[]}]},"httpPath":"/v1/deliverables"},{"label":"Get a deliverable","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/deliverables/getdeliverable","routeSlug":"/solutions/fdplan/apis/fdplan-studies/deliverables/getdeliverable","metadata":{"seo":{"title":"Get a deliverable","description":"Returns the full detail of a single deliverable, including its assigned data source, status, contributors, approvers, and due date. Requires the owning studyId alongside the deliverableId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeliverable","name":"Get a deliverable","isWebhook":false,"pointer":"/paths/~1v1~1deliverables~1{deliverableId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a deliverable","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the full detail of a single deliverable, including its assigned\ndata source, status, contributors, approvers, and due date. Requires the\nowning studyId alongside the deliverableId.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliverableId","in":"path","schemaId":"schema_2","description":"The ID of the deliverable to get.","required":true}],"pointer":"/paths/~1v1~1deliverables~1{deliverableId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"studyId","in":"query","schemaId":"schema_2","description":"The study which the deliverable belongs to.","required":true}],"pointer":"/paths/~1v1~1deliverables~1{deliverableId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1deliverables~1{deliverableId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/deliverables/{deliverableId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"deliverableId","in":"path","required":true,"schemaId":"schema_2"}],"query":[{"name":"studyId","in":"query","required":true,"schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","451","503","default"],"pointer":"/v1/deliverables/{deliverableId}","href":"deliverables/getdeliverable","openApiOperationId":"getDeliverable","summary":"Get a deliverable"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deliverable retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeliverableDetail"}},"schemaId":"components/schemas/DeliverableDetail"},{"code":"400","description":"Invalid study or deliverable ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1deliverables~1{deliverableId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeliverableDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeliverableDetail"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deliverables/getdeliverable"}],"panels":[]}]},"httpPath":"/v1/deliverables/{deliverableId}"},{"label":"Update a deliverable","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/deliverables/patchdeliverable","routeSlug":"/solutions/fdplan/apis/fdplan-studies/deliverables/patchdeliverable","metadata":{"seo":{"title":"Update a deliverable","description":"Applies partial updates to an existing deliverable using JSON-Patch replace and remove operations, for example to assign a data source or advance its approval status. The title, description, owner, contributors, approvers, due date, status, comments, and data source fields can be updated; the remove operation is only supported for the dataSource path."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDeliverable","name":"Update a deliverable","isWebhook":false,"pointer":"/paths/~1v1~1deliverables~1{deliverableId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a deliverable","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Applies partial updates to an existing deliverable using JSON-Patch\nreplace and remove operations, for example to assign a data source or\nadvance its approval status. The title, description, owner, contributors,\napprovers, due date, status, comments, and data source fields can be\nupdated; the remove operation is only supported for the dataSource path.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliverableId","in":"path","schemaId":"schema_2","description":"The ID of the deliverable to update.","required":true}],"pointer":"/paths/~1v1~1deliverables~1{deliverableId}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"studyId","in":"query","schemaId":"schema_2","description":"The study which the deliverable belong to.","required":true}],"pointer":"/paths/~1v1~1deliverables~1{deliverableId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1deliverables~1{deliverableId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"schemaId":"components/schemas/PatchReq","pointer":"/paths/~1v1~1deliverables~1{deliverableId}/patch/requestBody","description":"The patches to apply to the deliverable. Only \"replace\" and \"remove\" operations are supported. The \"remove\" operation is only supported for the \"dataSource\" path."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/deliverables/{deliverableId}","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"deliverableId","in":"path","required":true,"schemaId":"schema_2"}],"query":[{"name":"studyId","in":"query","required":true,"schemaId":"schema_2"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"responseCodes":["200","400","401","404","451","503","default"],"pointer":"/v1/deliverables/{deliverableId}","href":"deliverables/patchdeliverable","openApiOperationId":"patchDeliverable","summary":"Update a deliverable"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/PatchReq","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchReq"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deliverable updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Deliverable"}},"schemaId":"components/schemas/Deliverable"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The deliverable was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"451","description":"Unavailable for legal reasons.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1deliverables~1{deliverableId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Deliverable","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Deliverable"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"451","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deliverables/patchdeliverable"}],"panels":[]}]},"httpPath":"/v1/deliverables/{deliverableId}"}],"content":{"contentType":"group","meta":{"name":"Deliverables"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deliverables","showPageActions":true},{"nodeType":"markdoc","content":"Manage deliverables."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/deliverables","summary":"Get all deliverables","prefix":{"name":"get","color":"get"},"badges":[],"link":"/deliverables/getdeliverables","deprecated":false},{"title":"/v1/deliverables/{deliverableId}","summary":"Get a deliverable","prefix":{"name":"get","color":"get"},"badges":[],"link":"/deliverables/getdeliverable","deprecated":false},{"title":"/v1/deliverables/{deliverableId}","summary":"Update a deliverable","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/deliverables/patchdeliverable","deprecated":false}]}]}]}]}},{"type":"group","label":"Opportunities","link":"/solutions/fdplan/apis/fdplan-studies/opportunities","routeSlug":"/solutions/fdplan/apis/fdplan-studies/opportunities","items":[{"label":"Get the list of opportunities for the given study.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/opportunities/getopportunities","routeSlug":"/solutions/fdplan/apis/fdplan-studies/opportunities/getopportunities","metadata":{"seo":{"title":"Get the list of opportunities for the given study.","description":"Returns the opportunities registered for the given study. Requires the studyId and is paginated with the pageNumber and pageSize parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOpportunities","name":"Get the list of opportunities for the given study.","isWebhook":false,"pointer":"/paths/~1v1~1opportunities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the list of opportunities for the given study.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the opportunities registered for the given study. Requires the\nstudyId and is paginated with the pageNumber and pageSize parameters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"studyId","in":"query","schemaId":"schema_2","description":"The study","required":true},{"name":"pageNumber","in":"query","schemaId":"schema_0","description":"The number of the page in the list of Opportunities"},{"name":"pageSize","in":"query","schemaId":"schema_7","description":"The number of Opportunities per page"}],"pointer":"/paths/~1v1~1opportunities/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1opportunities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/opportunities","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"studyId","in":"query","required":true,"schemaId":"schema_2"},{"name":"pageNumber","in":"query","schemaId":"schema_0"},{"name":"pageSize","in":"query","schemaId":"schema_7"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","204","401","404","503","default"],"pointer":"/v1/opportunities","href":"opportunities/getopportunities","openApiOperationId":"getOpportunities","summary":"Get the list of opportunities for the given study."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OpportunityCollection"}},"schemaId":"components/schemas/OpportunityCollection"},{"code":"204","description":"Study contains no opportunities."},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The studyID was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1opportunities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OpportunityCollection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OpportunityCollection"}}},{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503"},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/opportunities/getopportunities"}],"panels":[]}]},"httpPath":"/v1/opportunities"}],"content":{"contentType":"group","meta":{"name":"Opportunities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Opportunities","showPageActions":true},{"nodeType":"markdoc","content":"Manage opportunities."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/opportunities","summary":"Get the list of opportunities for the given study.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/opportunities/getopportunities","deprecated":false}]}]}]}]}},{"type":"group","label":"Scores","link":"/solutions/fdplan/apis/fdplan-studies/scores","routeSlug":"/solutions/fdplan/apis/fdplan-studies/scores","items":[{"label":"Get ranking scores for the scenarios in the given study ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/fdplan/apis/fdplan-studies/scores/getscores","routeSlug":"/solutions/fdplan/apis/fdplan-studies/scores/getscores","metadata":{"seo":{"title":"Get ranking scores for the scenarios in the given study ID.","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getScores","name":"Get ranking scores for the scenarios in the given study ID.","isWebhook":false,"pointer":"/paths/~1v1~1scenario-ranking-scores/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get ranking scores for the scenarios in the given study ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the ranking scores computed for the scenarios in the given study,\nused to compare and rank candidate development options. Set\nincludeCriteriaScores to also return the per-criterion score breakdown;\nresults are paginated with the pageNumber and pageSize parameters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearer","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"},{"name":"appkey","scopes":[],"type":"apiKey","in":"header","paramName":"appkey"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"studyId","in":"query","schemaId":"schema_2","description":"The ID of the study for which to get the scenario ranking scores","required":true},{"name":"pageNumber","in":"query","schemaId":"schema_0","description":"The number of the page in the list of ranking scores."},{"name":"pageSize","in":"query","schemaId":"schema_7","description":"The number of ranking scores per page."},{"name":"includeCriteriaScores","in":"query","schemaId":"schema_8","description":"Whether to include criteria scores break-down in the response"}],"pointer":"/paths/~1v1~1scenario-ranking-scores/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"slb-partition-id","in":"header","schemaId":"schema_2","description":"Data partition id.","required":true}],"pointer":"/paths/~1v1~1scenario-ranking-scores/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/scenario-ranking-scores","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"studyId","in":"query","required":true,"schemaId":"schema_2"},{"name":"pageNumber","in":"query","schemaId":"schema_0"},{"name":"pageSize","in":"query","schemaId":"schema_7"},{"name":"includeCriteriaScores","in":"query","schemaId":"schema_8"}],"querystring":[],"header":[{"name":"slb-partition-id","in":"header","required":true,"schemaId":"schema_2"}],"cookie":[]},"security":[{"schemes":[{"id":"bearer","type":"apiKey","name":"Authorization","in":"header"},{"id":"appkey","type":"apiKey","name":"appkey","in":"header"}],"scopes":[]}],"responseCodes":["200","204","400","401","404","503","default"],"pointer":"/v1/scenario-ranking-scores","href":"scores/getscores","openApiOperationId":"getScores","summary":"Get ranking scores for the scenarios in the given study ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetScoresResponse"}},"schemaId":"components/schemas/GetScoresResponse"},{"code":"204","description":"No ranking scores found for given study ID."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The studyID was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"default","description":"Unexpected error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1scenario-ranking-scores/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetScoresResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetScoresResponse"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scores/getscores"}],"panels":[]}]},"httpPath":"/v1/scenario-ranking-scores"}],"content":{"contentType":"group","meta":{"name":"Scores"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scores","showPageActions":true},{"nodeType":"markdoc","content":"Manage scenario ranking scores."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/scenario-ranking-scores","summary":"Get ranking scores for the scenarios in the given study ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scores/getscores","deprecated":false}]}]}]}]}},{"type":"group","label":"Schema Definitions","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions","items":[{"type":"link","label":"CorrelationId","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/correlationid","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/correlationid","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CorrelationId"},"seo":{"title":"CorrelationId"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CorrelationId","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CorrelationId"},"children":[]}]}]}},{"type":"link","label":"Error","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/error","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/error","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Error"},"seo":{"title":"Error"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Error","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Error"},"children":[]}]}]}},{"type":"link","label":"NonCompliantStudy","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/noncompliantstudy","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/noncompliantstudy","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"NonCompliantStudy"},"seo":{"title":"NonCompliantStudy"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"NonCompliantStudy","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/NonCompliantStudy"},"children":[]}]}]}},{"type":"link","label":"Studies","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/studies","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/studies","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Studies"},"seo":{"title":"Studies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Studies","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Studies"},"children":[]}]}]}},{"type":"link","label":"CreateStudyRequest","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/createstudyrequest","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/createstudyrequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateStudyRequest"},"seo":{"title":"CreateStudyRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateStudyRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateStudyRequest"},"children":[]}]}]}},{"type":"link","label":"Study","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/study","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/study","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Study"},"seo":{"title":"Study"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Study","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Study"},"children":[]}]}]}},{"type":"link","label":"StudyDetail","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/studydetail","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/studydetail","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"StudyDetail"},"seo":{"title":"StudyDetail"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"StudyDetail","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/StudyDetail"},"children":[]}]}]}},{"type":"link","label":"EvaluationConfiguration","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/evaluationconfiguration","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/evaluationconfiguration","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"EvaluationConfiguration"},"seo":{"title":"EvaluationConfiguration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"EvaluationConfiguration","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/EvaluationConfiguration"},"children":[]}]}]}},{"type":"link","label":"GeoPoint","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/geopoint","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/geopoint","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"GeoPoint"},"seo":{"title":"GeoPoint"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GeoPoint","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/GeoPoint"},"children":[]}]}]}},{"type":"link","label":"LegalTag","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/legaltag","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/legaltag","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"LegalTag"},"seo":{"title":"LegalTag"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"LegalTag","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/LegalTag"},"children":[]}]}]}},{"type":"link","label":"Scenarios","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/scenarios","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/scenarios","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Scenarios"},"seo":{"title":"Scenarios"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scenarios","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Scenarios"},"children":[]}]}]}},{"type":"link","label":"CreateScenarioRequest","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/createscenariorequest","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/createscenariorequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateScenarioRequest"},"seo":{"title":"CreateScenarioRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateScenarioRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateScenarioRequest"},"children":[]}]}]}},{"type":"link","label":"Scenario","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/scenario","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/scenario","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Scenario"},"seo":{"title":"Scenario"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scenario","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Scenario"},"children":[]}]}]}},{"type":"link","label":"ScenarioResultsState","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/scenarioresultsstate","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/scenarioresultsstate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ScenarioResultsState"},"seo":{"title":"ScenarioResultsState"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ScenarioResultsState","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ScenarioResultsState"},"children":[]}]}]}},{"type":"link","label":"RealizationState","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/realizationstate","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/realizationstate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"RealizationState"},"seo":{"title":"RealizationState"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"RealizationState","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/RealizationState"},"children":[]}]}]}},{"type":"link","label":"ResultsError","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/resultserror","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/resultserror","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ResultsError"},"seo":{"title":"ResultsError"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ResultsError","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ResultsError"},"children":[]}]}]}},{"type":"link","label":"SpecAddress","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/specaddress","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/specaddress","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"SpecAddress"},"seo":{"title":"SpecAddress"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SpecAddress","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/SpecAddress"},"children":[]}]}]}},{"type":"link","label":"ComputationState","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/computationstate","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/computationstate","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ComputationState"},"seo":{"title":"ComputationState"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationState","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ComputationState"},"children":[]}]}]}},{"type":"link","label":"ComputationError","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/computationerror","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/computationerror","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ComputationError"},"seo":{"title":"ComputationError"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ComputationError","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ComputationError"},"children":[]}]}]}},{"type":"link","label":"CreateKpiRequest","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/createkpirequest","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/createkpirequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CreateKpiRequest"},"seo":{"title":"CreateKpiRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CreateKpiRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CreateKpiRequest"},"children":[]}]}]}},{"type":"link","label":"Kpi","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/kpi","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/kpi","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Kpi"},"seo":{"title":"Kpi"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Kpi","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Kpi"},"children":[]}]}]}},{"type":"link","label":"Decision","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/decision","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/decision","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Decision"},"seo":{"title":"Decision"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Decision","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Decision"},"children":[]}]}]}},{"type":"link","label":"Choice","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/choice","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/choice","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Choice"},"seo":{"title":"Choice"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Choice","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Choice"},"children":[]}]}]}},{"type":"link","label":"KpiCollection","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/kpicollection","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/kpicollection","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"KpiCollection"},"seo":{"title":"KpiCollection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KpiCollection","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/KpiCollection"},"children":[]}]}]}},{"type":"link","label":"Deliverables","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/deliverables","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/deliverables","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Deliverables"},"seo":{"title":"Deliverables"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deliverables","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Deliverables"},"children":[]}]}]}},{"type":"link","label":"Deliverable","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/deliverable","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/deliverable","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Deliverable"},"seo":{"title":"Deliverable"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deliverable","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Deliverable"},"children":[]}]}]}},{"type":"link","label":"DeliverableDetail","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/deliverabledetail","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/deliverabledetail","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"DeliverableDetail"},"seo":{"title":"DeliverableDetail"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DeliverableDetail","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/DeliverableDetail"},"children":[]}]}]}},{"type":"link","label":"LastUpdated","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/lastupdated","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/lastupdated","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"LastUpdated"},"seo":{"title":"LastUpdated"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"LastUpdated","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/LastUpdated"},"children":[]}]}]}},{"type":"link","label":"Created","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/created","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/created","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Created"},"seo":{"title":"Created"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Created","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Created"},"children":[]}]}]}},{"type":"link","label":"PatchReq","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/patchreq","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/patchreq","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PatchReq"},"seo":{"title":"PatchReq"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PatchReq","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PatchReq"},"children":[]}]}]}},{"type":"link","label":"PatchItem","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/patchitem","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/patchitem","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PatchItem"},"seo":{"title":"PatchItem"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PatchItem","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PatchItem"},"children":[]}]}]}},{"type":"link","label":"KpoCollection","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/kpocollection","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/kpocollection","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"KpoCollection"},"seo":{"title":"KpoCollection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KpoCollection","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/KpoCollection"},"children":[]}]}]}},{"type":"link","label":"Kpo","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/kpo","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/kpo","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Kpo"},"seo":{"title":"Kpo"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Kpo","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Kpo"},"children":[]}]}]}},{"type":"link","label":"VersionId","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/versionid","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/versionid","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"VersionId"},"seo":{"title":"VersionId"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VersionId","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/VersionId"},"children":[]}]}]}},{"type":"link","label":"OpportunityCollection","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/opportunitycollection","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/opportunitycollection","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"OpportunityCollection"},"seo":{"title":"OpportunityCollection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OpportunityCollection","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/OpportunityCollection"},"children":[]}]}]}},{"type":"link","label":"Opportunity","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/opportunity","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/opportunity","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Opportunity"},"seo":{"title":"Opportunity"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Opportunity","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Opportunity"},"children":[]}]}]}},{"type":"link","label":"Access Control List","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/acl","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/acl","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"Acl"},"seo":{"title":"Access Control List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Access Control List","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/Acl"},"children":[]}]}]}},{"type":"link","label":"OpportunityRegisterDetails","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/opportunityregisterdetails","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/opportunityregisterdetails","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"OpportunityRegisterDetails"},"seo":{"title":"OpportunityRegisterDetails"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OpportunityRegisterDetails","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/OpportunityRegisterDetails"},"children":[]}]}]}},{"type":"link","label":"GetScoresResponse","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/getscoresresponse","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/getscoresresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"GetScoresResponse"},"seo":{"title":"GetScoresResponse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GetScoresResponse","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/GetScoresResponse"},"children":[]}]}]}},{"type":"link","label":"ScenarioScore","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/scenarioscore","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/scenarioscore","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"ScenarioScore"},"seo":{"title":"ScenarioScore"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ScenarioScore","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/ScenarioScore"},"children":[]}]}]}},{"type":"link","label":"CriterionScore","link":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/criterionscore","routeSlug":"/solutions/fdplan/apis/fdplan-studies/schema-definitions/criterionscore","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"CriterionScore"},"seo":{"title":"CriterionScore"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CriterionScore","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/CriterionScore"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Schema Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schema Definitions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"CorrelationId","link":"/schema-definitions/correlationid","deprecated":false},{"title":"Error","link":"/schema-definitions/error","deprecated":false},{"title":"NonCompliantStudy","link":"/schema-definitions/noncompliantstudy","deprecated":false},{"title":"Studies","link":"/schema-definitions/studies","deprecated":false},{"title":"CreateStudyRequest","link":"/schema-definitions/createstudyrequest","deprecated":false},{"title":"Study","link":"/schema-definitions/study","deprecated":false},{"title":"StudyDetail","link":"/schema-definitions/studydetail","deprecated":false},{"title":"EvaluationConfiguration","link":"/schema-definitions/evaluationconfiguration","deprecated":false},{"title":"GeoPoint","link":"/schema-definitions/geopoint","deprecated":false},{"title":"LegalTag","link":"/schema-definitions/legaltag","deprecated":false},{"title":"Scenarios","link":"/schema-definitions/scenarios","deprecated":false},{"title":"CreateScenarioRequest","link":"/schema-definitions/createscenariorequest","deprecated":false},{"title":"Scenario","link":"/schema-definitions/scenario","deprecated":false},{"title":"ScenarioResultsState","link":"/schema-definitions/scenarioresultsstate","deprecated":false},{"title":"RealizationState","link":"/schema-definitions/realizationstate","deprecated":false},{"title":"ResultsError","link":"/schema-definitions/resultserror","deprecated":false},{"title":"SpecAddress","link":"/schema-definitions/specaddress","deprecated":false},{"title":"ComputationState","link":"/schema-definitions/computationstate","deprecated":false},{"title":"ComputationError","link":"/schema-definitions/computationerror","deprecated":false},{"title":"CreateKpiRequest","link":"/schema-definitions/createkpirequest","deprecated":false},{"title":"Kpi","link":"/schema-definitions/kpi","deprecated":false},{"title":"Decision","link":"/schema-definitions/decision","deprecated":false},{"title":"Choice","link":"/schema-definitions/choice","deprecated":false},{"title":"KpiCollection","link":"/schema-definitions/kpicollection","deprecated":false},{"title":"Deliverables","link":"/schema-definitions/deliverables","deprecated":false},{"title":"Deliverable","link":"/schema-definitions/deliverable","deprecated":false},{"title":"DeliverableDetail","link":"/schema-definitions/deliverabledetail","deprecated":false},{"title":"LastUpdated","link":"/schema-definitions/lastupdated","deprecated":false},{"title":"Created","link":"/schema-definitions/created","deprecated":false},{"title":"PatchReq","link":"/schema-definitions/patchreq","deprecated":false},{"title":"PatchItem","link":"/schema-definitions/patchitem","deprecated":false},{"title":"KpoCollection","link":"/schema-definitions/kpocollection","deprecated":false},{"title":"Kpo","link":"/schema-definitions/kpo","deprecated":false},{"title":"VersionId","link":"/schema-definitions/versionid","deprecated":false},{"title":"OpportunityCollection","link":"/schema-definitions/opportunitycollection","deprecated":false},{"title":"Opportunity","link":"/schema-definitions/opportunity","deprecated":false},{"title":"Access Control List","link":"/schema-definitions/acl","deprecated":false},{"title":"OpportunityRegisterDetails","link":"/schema-definitions/opportunityregisterdetails","deprecated":false},{"title":"GetScoresResponse","link":"/schema-definitions/getscoresresponse","deprecated":false},{"title":"ScenarioScore","link":"/schema-definitions/scenarioscore","deprecated":false},{"title":"CriterionScore","link":"/schema-definitions/criterionscore","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CorrelationId":{"id":"components/schemas/CorrelationId","kind":"json-schema","title":"CorrelationId","data":{"description":"The correlation ID for the request.","type":"string"}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"description":"Generic error response.","required":["data"],"type":"object","properties":{"data":{"required":["code"],"type":"object","properties":{"code":{"format":"int32","description":"The HTTP status code.","type":"integer","example":500},"message":{"description":"The error message.","type":"string","example":"internal server error"}}}},"example":{"data":{"code":500,"message":"internal server error"}}}},"components/schemas/NonCompliantStudy":{"id":"components/schemas/NonCompliantStudy","kind":"json-schema","title":"NonCompliantStudy","data":{"required":["ID","title","isArchived","isLegallyCompliant","version","legalTags"],"type":"object","properties":{"ID":{"description":"The ID of this study. This field is immutable.","type":"string"},"title":{"description":"The title of this study.","type":"string"},"isArchived":{"description":"Is the study hidden.","type":"boolean"},"isLegallyCompliant":{"description":"Always false (all studies in this list are non-compliant)","type":"boolean"},"version":{"description":"The version of the described study.","type":"integer"},"legalTags":{"description":"The legal tag(s) for the Study","type":"array","items":{"$ref":"#/components/schemas/LegalTag"}},"projectID":{"description":"The linked project id, if any.","type":"string"},"projectName":{"description":"The name of the linked project, mandatory if a project is linked.","type":"string"},"projectStageID":{"description":"The stage id of the linked project, mandatory if a project is linked.","type":"string"},"projectStageName":{"description":"The name of the linked project stage, mandatory if a project is linked.","type":"string"}},"example":{"ID":"01CP3E6EJJ25J29YHZ0K4RDZH8","title":"Robin Field Development","isArchived":false,"isLegallyCompliant":false,"version":1,"legalTags":[{"name":"public-usa-dataset-1","description":"A LegalTag used for demonstration purposes."}],"projectName":"New development opportunity."}}},"components/schemas/Studies":{"id":"components/schemas/Studies","kind":"json-schema","title":"Studies","data":{"description":"A list of studies.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Study"}}},"example":{"items":[{"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}}]}}},"components/schemas/CreateStudyRequest":{"id":"components/schemas/CreateStudyRequest","kind":"json-schema","title":"CreateStudyRequest","data":{"required":["title","workflowSpecId","workflowSpecVersion","acl"],"type":"object","properties":{"title":{"description":"The title of this study.","type":"string"},"description":{"description":"The description of this study.","type":"string"},"workflowSpecId":{"description":"The identifier for the evaluation workflow specification to be used in the study.","type":"string"},"workflowSpecVersion":{"format":"int32","description":"The identifier for the evaluation workflow specification version to be used in the study.","minimum":1,"type":"integer"},"legalTags":{"description":"Names of the Legal Tag(s) that are assigned to the Study.","type":"array","items":{"type":"string"}},"acl":{"$ref":"#/components/schemas/Acl"},"evaluationConfiguration":{"$ref":"#/components/schemas/EvaluationConfiguration"}},"example":{"title":"Robin Field Development","description":"New development opportunity.","workflowSpecId":"01CP3E6EJJ25J29YHZ0K4RDZH8","workflowSpecVersion":1,"legalTags":["legal-tag"],"acl":{"owners":["data.default.owners@data-partition-id.enterprisedata.slb.com","data.team.owners@data-partition-id.enterprisedata.slb.com"],"viewers":["data.default.viewers@data-partition-id.enterprisedata.slb.com","data.team.viewers@data-partition-id.enterprisedata.slb.com"]}}}},"components/schemas/Study":{"id":"components/schemas/Study","kind":"json-schema","title":"Study","data":{"required":["id","title","description","country","isArchived"],"type":"object","properties":{"id":{"description":"The ID of this study. This field is immutable.","type":"string","example":"01CP3E6EJJ25J29YHZ0K4RDZH8"},"title":{"description":"The title of this study.","type":"string","example":"Robin Field Development"},"description":{"description":"Description of the study.","type":"string","example":"New development opportunity."},"country":{"description":"The country code of this study.","type":"string","example":"US"},"isArchived":{"description":"Archived status of this study.","type":"boolean","example":false},"noOfRealizations":{"format":"int32","description":"The number of realizations for each study scenario.","type":"integer"},"uncertaintyMethod":{"description":"Methodology selected for uncertainty","default":"MonteCarlo","enum":["Unset","MonteCarlo","Deterministic"],"type":"string"},"workflowSpec":{"$ref":"#/components/schemas/VersionId"},"acl":{"$ref":"#/components/schemas/Acl"},"evaluationConfiguration":{"$ref":"#/components/schemas/EvaluationConfiguration"}},"example":{"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.default.owners@data-partition-id.enterprisedata.slb.com","data.team.owners@data-partition-id.enterprisedata.slb.com"],"viewers":["data.default.viewers@data-partition-id.enterprisedata.slb.com","data.team.viewers@data-partition-id.enterprisedata.slb.com"]}}}},"components/schemas/StudyDetail":{"id":"components/schemas/StudyDetail","kind":"json-schema","title":"StudyDetail","data":{"required":["id","title"],"type":"object","properties":{"id":{"description":"The ID of this study. This field is immutable.","type":"string","example":"01CP3E6EJJ25J29YHZ0K4RDZH8"},"title":{"description":"The title of this study.","type":"string","example":"Robin Field Development"},"stage":{"description":"The stage of the study (appraise, select, etc).","type":"string","example":"appraise"},"status":{"description":"The status of the study.","type":"string","example":"Opportunity Framing"},"isArchived":{"description":"Is the study hidden.","type":"boolean","example":false},"finalInvestmentDecisionDate":{"format":"date-time","description":"The date of the final investment decision.","type":["string","null"],"example":"2020-09-08T09:53:36.000Z"},"stageEnd":{"format":"date-time","description":"The stage end date.","type":["string","null"],"example":"2020-09-08T09:53:36.000Z"},"country":{"description":"The country of the study.","type":"string","example":"us"},"fieldName":{"description":"The name of the field.","type":"string","example":"Robin Field"},"fieldEnvironment":{"description":"The type of field location. The value Offshore has been deprecated.","enum":["Offshore","Onshore","Shallow water","Deep water"],"type":"string","example":"Offshore"},"fieldType":{"description":"Whether or not the field has already been developed.","enum":["Greenfield","Brownfield"],"type":"string","example":"Brownfield"},"fieldLocation":{"$ref":"#/components/schemas/GeoPoint"},"legalTags":{"description":"The legal tag(s) for the Study","type":"array","items":{"$ref":"#/components/schemas/LegalTag"}},"lastUpdated":{"$ref":"#/components/schemas/LastUpdated"},"deepLink":{"description":"Link to the FDPlan overview page for the study.","type":"string"},"noOfRealizations":{"format":"int32","description":"The number of realizations for each study scenario.","type":"integer"},"uncertaintyMethod":{"description":"Methodology selected for uncertainty","default":"MonteCarlo","enum":["Unset","MonteCarlo","Deterministic"],"type":"string"},"workflowSpec":{"$ref":"#/components/schemas/VersionId"},"acl":{"$ref":"#/components/schemas/Acl"},"evaluationConfiguration":{"$ref":"#/components/schemas/EvaluationConfiguration"}},"example":{"id":"01CP3E6EJJ25J29YHZ0K4RDZH8","title":"Robin Field Development","country":"US","isArchived":false,"noOfRealizations":10,"uncertaintyMethod":"MonteCarlo","workflowSpec":{"id":"01FDYW0CS3GYWBH7S080PMJ66F","version":1},"acl":{"owners":["data.default.owners@data-partition-id.enterprisedata.slb.com","data.team.owners@data-partition-id.enterprisedata.slb.com"],"viewers":["data.default.viewers@data-partition-id.enterprisedata.slb.com","data.team.viewers@data-partition-id.enterprisedata.slb.com"]}}}},"components/schemas/EvaluationConfiguration":{"id":"components/schemas/EvaluationConfiguration","kind":"json-schema","title":"EvaluationConfiguration","data":{"type":"object","properties":{"runtimeVersionId":{"description":"The id of the runtime version.","pattern":"^[a-z]([a-z0-9]|-)*[a-z0-9]:runtime-versions:[a-z]([a-z0-9]|-)*[a-z0-9]$","type":["string","null"]}}}},"components/schemas/GeoPoint":{"id":"components/schemas/GeoPoint","kind":"json-schema","title":"GeoPoint","data":{"description":"A geographical point containing geographic point coordinates.","type":"object","properties":{"latitude":{"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The latitude. North-South co-ordinate of the location in signed decimal degrees (-90 to +90)."},"children":[]}]}]}],"type":["number","null"],"example":1.299},"longitude":{"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The longitude. East-West co-ordinate of the location in signed decimal degrees (-180 to +180)."},"children":[]}]}]}],"type":["number","null"],"example":1.299}},"example":{"latitude":1.299,"longitude":51.6224}}},"components/schemas/LegalTag":{"id":"components/schemas/LegalTag","kind":"json-schema","title":"LegalTag","data":{"description":"A legal tag.","required":["name"],"type":"object","properties":{"name":{"description":"The name of the Legal Tag.","type":"string","example":"public-usa-dataset-1"},"description":{"description":"The description of the Legal Tag.","type":"string","example":"A LegalTag used for demonstration purposes."}},"example":{"name":"public-usa-dataset-1","description":"A LegalTag used for demonstration purposes."}}},"components/schemas/Scenarios":{"id":"components/schemas/Scenarios","kind":"json-schema","title":"Scenarios","data":{"description":"A list of scenarios.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Scenario"}}},"example":{"items":[{"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"}]}}},"components/schemas/CreateScenarioRequest":{"id":"components/schemas/CreateScenarioRequest","kind":"json-schema","title":"CreateScenarioRequest","data":{"required":["title"],"type":"object","properties":{"title":{"description":"The title of this scenario.","maxLength":100,"type":"string"},"colour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AA-friendly colour for scenario. Specified as hex, e.g '#FFA71A'."},"children":[]}]}]}],"pattern":"^#([A-Fa-f0-9]{6})$|^$","type":"string"},"description":{"description":"The description of this scenario.","maxLength":500,"type":"string"},"isSelected":{"description":"A scenario is marked as selected when it has been featured above other scenarios in the same study by a user.","type":"boolean"},"associatedOpportunityIDs":{"type":["array","null"],"items":{"description":"The opportunity ids which are associated with this scenario.","type":"string"}}},"example":{"title":"Minimal investment","colour":"#ff0000","description":"Minimal investment development option scenario.","isSelected":false,"associatedOpportunityIDs":["01CP3E6EJJ25J29YHZ0K4ANABC","01CP3E6EJJ25J29YHZ0K4ANDEF"]}}},"components/schemas/Scenario":{"id":"components/schemas/Scenario","kind":"json-schema","title":"Scenario","data":{"description":"A Study's scenarios.","type":"object","properties":{"id":{"description":"A scenario's unique identifier.","type":"string","example":"01CP3E6EJJ25J29YHZ0K4RDZH8"},"displayID":{"description":"The user-friendly ID of this scenario.","type":"string","example":"S1"},"ensembleID":{"description":"The ID of the ensemble that manages all the realizations associated with the scenario.","type":"string"},"title":{"description":"A scenario's title.","type":"string","example":"Minimal investment"},"description":{"description":"The description of this scenario.","type":"string","example":"Minimal investment development option scenario."},"lastUpdated":{"$ref":"#/components/schemas/LastUpdated"},"created":{"$ref":"#/components/schemas/Created"},"isSelected":{"description":"A scenario is marked as selected when it has been featured above other scenarios in the same study by a user.","type":["boolean","null"],"example":true},"decisions":{"description":"The collection of the scenario's decisions.","type":"array","items":{"$ref":"#/components/schemas/Decision"}},"colour":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The colour of this scenario represented as a HTML hex value (e.g. \"#ffa71a\")."},"children":[]}]}]}],"type":"string","example":"#ff0000"},"version":{"format":"int32","description":"The version of the described scenario.","type":["integer","null"]},"associatedDevelopmentConceptId":{"description":"The development concept id which is associated with this scenario.","type":["string","null"],"example":"01CP3E6EJJ25J29YHZ0K4ANIH8"},"associatedOpportunityIDs":{"type":["array","null"],"items":{"description":"The opportunity ids which are associated with this scenario.","type":"string"}}},"example":{"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"]}}},"components/schemas/ScenarioResultsState":{"id":"components/schemas/ScenarioResultsState","kind":"json-schema","title":"ScenarioResultsState","data":{"required":["realizationStates","dataSourceProcessingState","resultsPublishingState"],"type":"object","properties":{"dataSource":{"$ref":"#/components/schemas/VersionId"},"dataSourceProcessingErrors":{"description":"A list of data source processing errors.","type":"array","items":{"type":"string"},"example":["first error","second error"]},"dataSourceProcessingState":{"description":"The data source processing state.","enum":["Unknown","InsufficientData","Running","CompletedSuccessfully","CompletedWithErrors"],"type":"string","example":"CompletedWithErrors"},"lastUpdated":{"format":"date-time","description":"The time when the scenario result state was last updated.","type":["string","null"],"example":"2020-09-08T09:53:36.000Z"},"realizationStates":{"description":"A list of realizations with corresponding states.","type":"array","items":{"$ref":"#/components/schemas/RealizationState"}},"resultsPublishingErrors":{"description":"A list of results publishing errors.","type":"array","items":{"type":"string"},"example":["a publishing error"]},"resultsPublishingState":{"description":"The results state for the scenario.","enum":["Unknown","InsufficientData","Running","CompletedSuccessfully","CompletedWithErrors"],"type":"string","example":"CompletedWithErrors"}},"example":{"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"}}},"components/schemas/RealizationState":{"id":"components/schemas/RealizationState","kind":"json-schema","title":"RealizationState","data":{"required":["uri","version","state"],"type":"object","properties":{"uri":{"description":"The URI of the realization","type":"string"},"version":{"format":"int32","description":"Version of the realization.","type":"integer","example":4},"state":{"description":"State of the realization.","enum":["Unknown","InsufficientData","Running","CompletedSuccessfully","CompletedWithErrors","Stopping","Stopped"],"type":"string","example":"CompletedWithErrors"},"lastUpdatedAt":{"format":"date-time","description":"The time when the realization was last updated.","type":["string","null"],"example":"2021-02-10T11:12:14.000Z"},"resultsErrors":{"type":"array","items":{"$ref":"#/components/schemas/ResultsError"}},"computationStates":{"description":"List of computation run states.","type":"array","items":{"$ref":"#/components/schemas/ComputationState"}}}}},"components/schemas/ResultsError":{"id":"components/schemas/ResultsError","kind":"json-schema","title":"ResultsError","data":{"required":["messageToUser"],"type":"object","properties":{"messageToUser":{"description":"A user-friendly message about the error which may be presented to the users of the system to help them correct the error.","type":"string","example":"An error has occured"},"addresses":{"description":"A list of Spec Addresses to allow the consumer to identify the workflow elements which the error applies to.","type":"array","items":{"$ref":"#/components/schemas/SpecAddress"}}}}},"components/schemas/SpecAddress":{"id":"components/schemas/SpecAddress","kind":"json-schema","title":"SpecAddress","data":{"description":"An address used to describe the location of a Spec within a WorkflowSpec. Used to enrich the spec model with additional attributes such as specifying the location of a data container or providing annotations.","required":["type","dataTypeIndex","computationIndex"],"type":"object","properties":{"type":{"description":"Whether the address refers to a data-type input, a data-type output or computation-spec.","enum":["Invalid","Computation","DataTypeInput","DataTypeOutput","Workflow"],"type":"string","example":"Computation"},"computationIndex":{"description":"The zero based index of the Computation Spec.","type":"integer","example":0},"dataTypeIndex":{"description":"The zero based index of a data-type with respect to a computation-spec. Inputs and outputs are treated as separate ordered lists.","type":"integer","example":1}}}},"components/schemas/ComputationState":{"id":"components/schemas/ComputationState","kind":"json-schema","title":"ComputationState","data":{"required":["address","runState"],"type":"object","properties":{"address":{"$ref":"#/components/schemas/SpecAddress"},"runState":{"description":"The run state of the computation.","enum":["Unknown","InsufficientData","Running","CompletedSuccessfully","CompletedWithErrors","Stopping","Stopped"],"type":"string","example":"CompletedWithErrors"},"errors":{"description":"A list of computation errors.","type":"array","items":{"$ref":"#/components/schemas/ComputationError"}}}}},"components/schemas/ComputationError":{"id":"components/schemas/ComputationError","kind":"json-schema","title":"ComputationError","data":{"required":["message","addresses"],"type":"object","properties":{"message":{"description":"A user-friendly message about the error which may be presented to the users of the system to help them correct the error.","type":"string","example":"No cost for event has been specified"},"addresses":{"description":"A list of workflow-spec addresses to describe the parts of a workflow which have resulted in the error.","type":"array","items":{"$ref":"#/components/schemas/SpecAddress"}}}}},"components/schemas/CreateKpiRequest":{"id":"components/schemas/CreateKpiRequest","kind":"json-schema","title":"CreateKpiRequest","data":{"required":["description","type","defaultObjectiveOperator"],"type":"object","properties":{"description":{"description":"The description of KPI.","pattern":"^[a-zA-Z0-9\\s\\-\\.\\,\\;\\:\\(\\)\\/&]{1,200}$","type":"string","example":"Capital Expenditures at first year"},"type":{"description":"The value type of KPI.","enum":["Money","Percentage","Date","Years","Ratio","Volume","Dimensionless"],"type":"string","example":"Money"},"defaultObjectiveOperator":{"description":"The default objective operator to be used for new KPOs created for the KPI.","enum":["Less Than","More Than","After","Before"],"type":"string","example":"Less Than"},"unit":{"description":"The unit of the KPI.","maxLength":50,"type":"string","example":"M$"},"priority":{"format":"int64","description":"The priority of the KPI. Increasing value indicates lower priority.","minimum":1,"type":"integer","example":11},"archived":{"description":"Whether this KPI has been marked as archived.","type":"boolean","example":false},"measurement":{"description":"The measurement for this KPI.","pattern":"^[\\w\\-\\.]+:reference-data\\-\\-UnitOfMeasure:[\\w\\-\\.\\:\\%]+:[0-9]*$","type":"string"}},"example":{"description":"Capital Expenditures at first year","type":"Money","defaultObjectiveOperator":"Less Than","unit":"M$","priority":11,"archived":false,"measurement":"osdu:reference-data--UnitOfMeasure:1E6%20USD:"}}},"components/schemas/Kpi":{"id":"components/schemas/Kpi","kind":"json-schema","title":"Kpi","data":{"allOf":[{"$ref":"#/components/schemas/CreateKpiRequest"},{"required":["name"],"type":"object","properties":{"name":{"description":"The name of this KPI. This field is immutable.","type":"string","example":"First Year Capex"},"isSystem":{"description":"Defines if the KPI is a system KPI.","type":"boolean","example":false},"lastUpdated":{"$ref":"#/components/schemas/LastUpdated"}},"example":{"name":"First Year Capex","isSystem":false,"lastUpdated":{"atDate":"2020-09-08T09: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}}]}},"components/schemas/Decision":{"id":"components/schemas/Decision","kind":"json-schema","title":"Decision","data":{"description":"A Scenario's decision.","type":"object","properties":{"id":{"description":"Decision's unique identifier.","type":"string","example":"01CP3E6EJJ25J29YHZ0K4RDZH8"},"title":{"description":"A decision's title.","type":"string","example":"A development decision"},"Choice":{"$ref":"#/components/schemas/Choice"},"description":{"description":"Description of this decision.","type":"string","example":"A development decision to be made."}},"example":{"id":"01CP3E6EJJ25J29YHZ0K4RDZH8","title":"A development decision"}}},"components/schemas/Choice":{"id":"components/schemas/Choice","kind":"json-schema","title":"Choice","data":{"description":"A possible option for a given decision.","type":"object","properties":{"id":{"description":"Choice's unique identifier.","type":"string","example":"01CP3E6EJJ25J29YHZ0K4RDZH8"},"title":{"description":"A choice's displayed title.","type":"string","example":"A development choice"},"description":{"description":"Description of this choice.","type":"string","example":"A development choice to be made."}},"example":{"id":"01CP3E6EJJ25J29YHZ0K4RDZH8","title":"A development decision","description":"A development choice to be made."}}},"components/schemas/KpiCollection":{"id":"components/schemas/KpiCollection","kind":"json-schema","title":"KpiCollection","data":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Kpi"}}},"example":{"items":[{"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}]}}},"components/schemas/Deliverables":{"id":"components/schemas/Deliverables","kind":"json-schema","title":"Deliverables","data":{"description":"A list of deliverables.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable"}}},"example":{"items":[{"id":"01CKXHZPAEERP06F3CNKBAPE0F","title":"Decline Curves","description":"Decline curves for Robin field.","status":"Requested","attachmentType":"decline-curves","attachmentTypeVersion":1},{"id":"01CKXHZPAEERP06F3SDFKJ567F","title":"Facility Constraints","description":"Facility Constraints for Robin field.","status":"Requested","attachmentType":"facility-constraints","attachmentTypeVersion":1}]}}},"components/schemas/Deliverable":{"id":"components/schemas/Deliverable","kind":"json-schema","title":"Deliverable","data":{"description":"A study deliverable.","required":["id","attachmentType","title","status"],"type":"object","properties":{"id":{"description":"Deliverable's unique identifier.","type":"string","example":"01CKXHZPAEERP06F3CNKBAPE0F"},"title":{"description":"The title of the deliverable.","type":"string","example":"Decline Curves"},"description":{"description":"The description of this deliverable.","type":"string","example":"Decline curves for Robin field."},"status":{"description":"The status of the deliverable.","enum":["New","Requested","In Progress","Pending Approval","Approved"],"type":"string","example":"Requested"},"attachmentType":{"description":"The FDPlan data-type ID for this deliverable's attachment.","type":"string","example":"decline-curves"},"attachmentTypeVersion":{"description":"The FDPlan data-type version for this deliverable's attachment.","type":"integer","example":1},"attachmentSpecAddress":{"$ref":"#/components/schemas/SpecAddress"},"attachment":{"description":"The relative URI to the deliverable's attachment. May be empty indicating that the deliverable has no attachment. NOTE: This field is deprecated in favour of dataSource.","type":"string"},"associatedScenarioId":{"description":"The ID of the scenario associated with this deliverable.","type":"string","example":"01CKXHZPAEERP06F3CNKBAPE0F"},"contributors":{"description":"A list of the IDs of users marked as contributing to this deliverable.","type":"array","items":{"type":"string"},"example":["user1@slb.com","user2@slb.com"]},"dataSource":{"$ref":"#/components/schemas/VersionId"}},"example":{"id":"01CKXHZPAEERP06F3CNKBAPE0F","title":"title","description":"description","status":"Requested","attachmentType":"decline-curves","attachmentTypeVersion":1}}},"components/schemas/DeliverableDetail":{"id":"components/schemas/DeliverableDetail","kind":"json-schema","title":"DeliverableDetail","data":{"description":"Details of a study deliverable.","required":["id"],"type":"object","properties":{"id":{"description":"Deliverable's unique identifier.","type":"string","example":"01CKXHZPAEERP06F3CNKBAPE0F"},"title":{"description":"The title of the deliverable.","type":"string","example":"Decline Curves"},"description":{"description":"The description of this deliverable.","type":"string","example":"Decline curves for Robin field."},"status":{"description":"The status of the deliverable.","enum":["New","Requested","In Progress","Pending Approval","Approved"],"type":"string","example":"Requested"},"attachmentType":{"description":"The FDPlan data-type ID for this deliverable's attachment.","type":"string","example":"decline-curves"},"attachmentTypeVersion":{"description":"The FDPlan data-type version for this deliverable's attachment.","type":"integer","example":1},"attachmentSpecAddress":{"$ref":"#/components/schemas/SpecAddress"},"attachment":{"description":"The relative URI to the deliverable's attachment. May be empty indicating that the deliverable has no attachment. NOTE: This field is deprecated in favour of dataSource.","type":"string"},"associatedScenarioId":{"description":"The ID of the scenario associated with this deliverable.","type":"string","example":"01CKXHZPAEERP06F3CNKBAPE0F"},"contributors":{"description":"A list of the IDs of users marked as contributing to this deliverable.","type":"array","items":{"type":"string"},"example":["user1@slb.com","user2@slb.com"]},"approvers":{"description":"A list of the IDs of users marked as approvers for this deliverable.","type":"array","items":{"type":"string"},"example":["user3@slb.com"]},"dueDate":{"format":"date-time","description":"The date by which the deliverable must be Approved","type":["string","null"],"example":"2020-09-08T09:53:36.000Z"},"lastUpdated":{"$ref":"#/components/schemas/LastUpdated"},"attachmentLastUpdated":{"$ref":"#/components/schemas/LastUpdated"},"dataSource":{"$ref":"#/components/schemas/VersionId"}},"example":{"id":"01CKXHZPAEERP06F3CNKBAPE0F","title":"title","description":"Decline curves for Robin field.","status":"Requested","attachmentType":"decline-curves","attachmentTypeVersion":1}}},"components/schemas/LastUpdated":{"id":"components/schemas/LastUpdated","kind":"json-schema","title":"LastUpdated","data":{"description":"Details of the last update to a resource.","required":["byUser","atDate","byEvent"],"type":"object","properties":{"byUser":{"description":"The ID of the user who made the most recent update.","type":"string","example":"user@slb.com"},"atDate":{"format":"date-time","description":"The date time of the last update.","type":["string","null"],"example":"2020-09-08T09:53:36.000Z"},"byEvent":{"$ref":"#/components/schemas/CorrelationId"}},"example":{"atDate":"2020-09-08T09:53:36.000Z","byEvent":"01EHPJ54HEA77K95T5KPH5JSW9","byUser":"user@slb.com"}}},"components/schemas/Created":{"id":"components/schemas/Created","kind":"json-schema","title":"Created","data":{"description":"Details about the creation of a resource.","required":["byUser","atDate","byEvent"],"type":"object","properties":{"byUser":{"description":"The ID of the user who created the resource.","type":"string","example":"user@slb.com"},"atDate":{"format":"date-time","description":"The date and time the resource was created.","type":["string","null"],"example":"2020-09-08T09:53:36.000Z"},"byEvent":{"$ref":"#/components/schemas/CorrelationId"}},"example":{"atDate":"2020-09-08T09:53:36.000Z","byEvent":"01EHPJ54HEA77K95T5KPH5JSW9","byUser":"user@slb.com"}}},"components/schemas/PatchReq":{"id":"components/schemas/PatchReq","kind":"json-schema","title":"PatchReq","data":{"description":"A list of patch items.","type":"array","items":{"$ref":"#/components/schemas/PatchItem"},"example":[{"op":"replace","path":"title","value":"title"},{"op":"replace","path":"description","value":"description"}]}},"components/schemas/PatchItem":{"id":"components/schemas/PatchItem","kind":"json-schema","title":"PatchItem","data":{"description":"A JSONPatch document as defined by RFC 6902.","required":["op","path"],"properties":{"op":{"description":"The operation to be performed.","enum":["replace","add","remove"],"type":"string","example":"replace"},"path":{"description":"A JSON-Pointer.","type":"string","example":"description"},"value":{"description":"The value to be used within the operations.","example":"New description"},"from":{"description":"A string containing a JSON Pointer value.","type":"string"}},"example":{"op":"replace","path":"description","value":"New description"}}},"components/schemas/KpoCollection":{"id":"components/schemas/KpoCollection","kind":"json-schema","title":"KpoCollection","data":{"description":"A list of KPOs.","required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Kpo"}}},"example":{"items":[{"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$"}]}}},"components/schemas/Kpo":{"id":"components/schemas/Kpo","kind":"json-schema","title":"Kpo","data":{"description":"A Key Performance Indicator (KPO).","required":["name","objectiveOperator"],"type":"object","properties":{"name":{"description":"The name of the KPI for this KPO. This field is immutable.","type":"string","example":"ATMaxEx"},"objectiveOperator":{"description":"The KPO objective operator which together with the objective value determines whether the KPO has been met or not. This will be more/less than if KPO is a number and before/after if KPO is a date.","type":"string","example":"Less Than"},"objectiveValue":{"description":"The KPO objective value which together with the objective operator determines whether the KPO has been met or not.","type":"string","example":"600"},"description":{"description":"The description of this KPO.","type":"string","example":"After Tax Maximum Exposure"},"type":{"description":"The value type of this KPO.","enum":["Money","Percentage","Date","Years","Ratio","Volume","Dimensionless"],"type":"string","example":"Money"},"unit":{"description":"The unit of the KPO.","type":"string","example":"M$"}},"example":{"name":"ATMaxEx","description":"After Tax Maximum Exposure","objectiveOperator":"Less Than","objectiveValue":"600","type":"Money","unit":"M$"}}},"components/schemas/VersionId":{"id":"components/schemas/VersionId","kind":"json-schema","title":"VersionId","data":{"description":"A versioned resource identifier.","required":["id","version"],"type":"object","properties":{"id":{"description":"The resource ID.","type":"string","example":"01CP3E6EJJ25J29YHZ0K4RDZH8"},"version":{"description":"The version of resource.","type":"integer","example":1}},"example":{"id":"01CP3E6EJJ25J29YHZ0K4RDZH8","version":1}}},"components/schemas/OpportunityCollection":{"id":"components/schemas/OpportunityCollection","kind":"json-schema","title":"OpportunityCollection","data":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Opportunity"}}}}},"components/schemas/Opportunity":{"id":"components/schemas/Opportunity","kind":"json-schema","title":"Opportunity","data":{"required":["ID","title","type"],"type":"object","properties":{"ID":{"description":"The ID of this opportunity. This field is immutable.","type":"string"},"title":{"description":"The title of this opportunity.","type":"string"},"displayID":{"description":"The user-friendly ID of this opportunity. This field is immutable.","type":"string"},"type":{"description":"The type of opportunity.","enum":["Base","Opportunity"],"type":"string"},"associatedBaseID":{"description":"The ID of the associated base opportunity.","type":"string"},"opportunityRegisterDetails":{"$ref":"#/components/schemas/OpportunityRegisterDetails"}}}},"components/schemas/Acl":{"id":"components/schemas/Acl","kind":"json-schema","title":"Access Control List","data":{"title":"Access Control List","description":"The access control list.","required":["owners","viewers"],"additionalProperties":false,"type":"object","properties":{"owners":{"title":"List of Owners","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of owners of this resource formatted as an email. By"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"convention owner data groups must begin with the prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only owner data groups formatted as emails are allowed here."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Owner data groups must begin with the prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owners"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data groups must have a corresponding valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"viewers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data group pair"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"viewers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property to ensure proper access control."},"children":[]}]}]}]}],"maxItems":20,"minItems":1,"uniqueItems":true,"type":"array","items":{"pattern":"^data\\.[a-zA-Z0-9_+&*-]+(?:\\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,7}$","type":"string"},"example":["data.default.owners@data-partition-id.enterprisedata.slb.com"]},"viewers":{"title":"List of Viewers","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of viewers to which this resource is accessible/visible/discoverable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"formatted as an email. By convention viewer data groups must begin"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only viewer data groups formatted as emails are allowed here."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viewer data groups must begin with the prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parity check: All "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"viewers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data groups must be valid pairs for their respective "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owners"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data groups to ensure proper access control."},"children":[]}]}]}]}],"maxItems":20,"minItems":1,"uniqueItems":true,"type":"array","items":{"pattern":"^data\\.[a-zA-Z0-9_+&*-]+(?:\\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,7}$","type":"string"},"example":["data.default.viewers@data-partition-id.enterprisedata.slb.com"]}},"example":{"owners":["data.default.owners@data-partition-id.enterprisedata.slb.com"],"viewers":["data.default.viewers@data-partition-id.enterprisedata.slb.com"]}}},"components/schemas/OpportunityRegisterDetails":{"id":"components/schemas/OpportunityRegisterDetails","kind":"json-schema","title":"OpportunityRegisterDetails","data":{"type":"object","properties":{"registerID":{"description":"The ID of the associated opportunity in the register.","type":["string","null"]},"registerVersion":{"format":"int64","description":"The version of the associated opportunity in the register.","minimum":1,"type":["integer","null"]}}}},"components/schemas/GetScoresResponse":{"id":"components/schemas/GetScoresResponse","kind":"json-schema","title":"GetScoresResponse","data":{"description":"Response to get ranking scores.","required":["items"],"type":"object","properties":{"items":{"description":"The ranking scores.","type":"array","items":{"$ref":"#/components/schemas/ScenarioScore"}}}}},"components/schemas/ScenarioScore":{"id":"components/schemas/ScenarioScore","kind":"json-schema","title":"ScenarioScore","data":{"description":"Ranking score of a scenario.","required":["scenarioId","score","scoreVersion"],"type":"object","properties":{"scenarioId":{"description":"ID of the scenario","type":"string"},"score":{"format":"double","description":"The score of the scenario.","type":"number"},"scoreVersion":{"format":"int32","description":"Version of the scenario score","type":"number"},"criteriaScores":{"description":"The scores of the criteria.","type":"array","items":{"$ref":"#/components/schemas/CriterionScore"},"x-omitempty":true}}}},"components/schemas/CriterionScore":{"id":"components/schemas/CriterionScore","kind":"json-schema","title":"CriterionScore","data":{"description":"Ranking score of a criterion for a scenario.","required":["id","version","score","weight"],"type":"object","properties":{"id":{"description":"ID of the criterion","type":"string"},"version":{"format":"int32","description":"Version of the criterion","type":"number"},"score":{"format":"double","description":"The score of the criterion.","type":"number"},"weight":{"format":"double","description":"The weight of the criterion score.","type":"number"}}}},"schema_0":{"kind":"json-schema","data":{"type":"integer","default":0},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"integer","default":100},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-zA-Z0-9\\s\\-\\.\\,\\;\\:\\(\\)&]{1,50}$"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"The URL of the created study."}}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"object","properties":{"Last-Modified":{"type":"string","description":"Date-time of when the study was last updated"}}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"The URL of the scenario."}}},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"integer","maximum":500,"default":100},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_8"}},"exampleStore":{},"securitySchemeStore":{"bearer":{"id":"bearer","type":"apiKey","in":"header","paramName":"Authorization"},"appkey":{"id":"appkey","type":"apiKey","in":"header","paramName":"appkey"}},"specVersion":"3.2.0","servers":[{"url":"https://api.delfi.slb.com/fdplan/studies"},{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"schemaDefinitionsTagName":"Schema Definitions","downloadUrls":[{"title":"Studies Spec","url":"https://developer.slb.com/fdplan/FDPlan-Studies.yaml"}],"mockServer":{"url":"/_mock/solutions/fdplan/apis/fdplan-studies","position":"last","description":"Mock server"},"disableRouter":true,"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Studies","description":"```plain {% title=\"Client ID\" %}\nprod-nam-services-fdplan.slbservice.com\nprod-eu-services-fdplan.slbservice.com\nprod-au-services-fdplan.slbservice.com\nprod-id-services-fdplan.slbservice.com\nproduction-services-fdplan.slbservice.com\n```\n\nThe studies API is responsible for study data within FDPlan.\n\nThe key API concepts include:\n\n* **studies**: A study covers the allocation of time and resources to gain\n  knowledge of an asset, identify potential opportunities and threats,\n  derive and evaluate candidate development scenarios, and make critical\n  decisions in field-development planning. It can also be referred to as an\n  asset evaluation project or a conceptual field-development planning\n  project. You can have several studies for different stages of\n  field-development planning, such as one study for the appraisal stage and\n  another for the concept selection stage.\n\n* **KPOs**: A key performance objective (KPO) is an objective that is\n  critical to the success of the project. Typically, three to five\n  objectives are identified as key objectives.\n\n* **KPIs**: A key performance indicator (KPI) represents the performance\n  of the current development scenario compared with the key performance\n  objective, for example, net present value (NPV),\n  internal rate of return (IRR), payback period, date of first oil,\n  maximum exposure, and proven reserves.\n\n* **decisions**: A decision must be made or has been made to define the\n  field-development plan. It can contain one or more available choices to\n  select. A decision is made when one of the available choices is selected.\n\n* **choices**: A choice is an option you can choose to make a decision. It\n  can also be referred to as a concept. There can be multiple available\n  choices in making a decision. A choice can be available or unavailable,\n  and can be selected or unselected.\n\n* **scenarios**: A scenario is a combination of development choices that\n  describes a particular way to develop a field. It can also be referred to\n  as a development scenario, a concept, or a development option.\n\n* **deliverables**: A deliverable is a work item in which you can manage the\n  life cycle of the required data or the documents for a study. It holds the\n  information on the status of the domain contribution, the contributors,\n  the approvers, and the due date. A contribution that fulfills a\n  deliverable is referred to as an 'data source'.\n"}},"baseSlug":"/solutions/fdplan/apis/fdplan-studies","routesMapping":{}}