swagger: "2.0"
info:
  title: Studies
  version: 1.0.0
  description: |
    ```plain {% title="Client ID" %}
    prod-nam-services-fdplan.slbservice.com
    prod-eu-services-fdplan.slbservice.com
    prod-au-services-fdplan.slbservice.com
    prod-id-services-fdplan.slbservice.com
    production-services-fdplan.slbservice.com
    ```

    The studies API is responsible for study data within FDPlan.

    The key API concepts include:

    * **studies**: A study covers the allocation of time and resources to gain
      knowledge of an asset, identify potential opportunities and threats,
      derive and evaluate candidate development scenarios, and make critical
      decisions in field-development planning. It can also be referred to as an
      asset evaluation project or a conceptual field-development planning
      project. You can have several studies for different stages of
      field-development planning, such as one study for the appraisal stage and
      another for the concept selection stage.

    * **KPOs**: A key performance objective (KPO) is an objective that is
      critical to the success of the project. Typically, three to five
      objectives are identified as key objectives.

    * **KPIs**: A key performance indicator (KPI) represents the performance
      of the current development scenario compared with the key performance
      objective, for example, net present value (NPV),
      internal rate of return (IRR), payback period, date of first oil,
      maximum exposure, and proven reserves.

    * **decisions**: A decision must be made or has been made to define the
      field-development plan. It can contain one or more available choices to
      select. A decision is made when one of the available choices is selected.

    * **choices**: A choice is an option you can choose to make a decision. It
      can also be referred to as a concept. There can be multiple available
      choices in making a decision. A choice can be available or unavailable,
      and can be selected or unselected.

    * **scenarios**: A scenario is a combination of development choices that
      describes a particular way to develop a field. It can also be referred to
      as a development scenario, a concept, or a development option.

    * **deliverables**: A deliverable is a work item in which you can manage the
      life cycle of the required data or the documents for a study. It holds the
      information on the status of the domain contribution, the contributors,
      the approvers, and the due date. A contribution that fulfills a
      deliverable is referred to as an 'data source'.
  contact:
    name: SLB Customer Support for Digital
    url: https://customersupport.digital.slb.com
  x-product-id: FDPlan-Studies
host: api.delfi.slb.com
basePath: /fdplan/studies
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  /v1/kpis:
    get:
      tags:
        - Kpis
      summary: 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.
      operationId: getKpis
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - in: query
          description: The number of the page in the list of KPIs
          name: pageNumber
          type: integer
          default: 0
          x-nullable: false
        - in: query
          description: The number of KPIs per page
          name: pageSize
          type: integer
          default: 100
          x-nullable: false
      responses:
        "200":
          description: Success.
          schema:
            $ref: '#/definitions/KpiCollection'
        "204":
          description: Success.
        "400":
          description: Bad request
          schema:
            $ref: '#/definitions/Error'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /v1/kpis/{kpiName}:
    put:
      tags:
        - Kpis
      summary: 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.
      operationId: putKpi
      produces:
        - application/json
      consumes:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: path
          description: The name of the KPI to update or create.
          name: kpiName
          type: string
          pattern: ^[a-zA-Z0-9\s\-\.\,\;\:\(\)&]{1,50}$
        - description: The KPI details to update or create.
          name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateKpiRequest'
      responses:
        "200":
          description: The KPI was updated.
          schema:
            $ref: '#/definitions/Kpi'
        "201":
          description: The KPI was created.
          schema:
            $ref: '#/definitions/Kpi'
        "400":
          description: Bad request
          schema:
            $ref: '#/definitions/Error'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /v1/studies:
    get:
      tags:
        - Studies
      summary: Get all studies
      description: |
        Returns all studies visible to the caller in the current partition.
      operationId: getStudies
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
      responses:
        "200":
          description: Retrieved studies successfully.
          schema:
            $ref: '#/definitions/Studies'
        "204":
          description: No studies were found.
        "401":
          description: Unauthorized.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
    post:
      tags:
        - Studies
      summary: 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.
      operationId: postStudy
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - description: The study that needs to be created.
          name: study
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateStudyRequest'
      responses:
        "201":
          description: Study created successfully.
          schema:
            $ref: '#/definitions/Study'
          headers:
            Location:
              type: string
              description: The URL of the created study.
              x-nullable: false
        "400":
          description: Bad request.
          schema:
            $ref: '#/definitions/Error'
        "451":
          description: One or more Legal Tags are invalid.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /v1/studies/{studyId}:
    get:
      tags:
        - Study
      summary: 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.
      operationId: getStudy
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: path
          description: The study to get.
          name: studyId
          type: string
      responses:
        "200":
          description: Study retrieved successfully.
          schema:
            $ref: '#/definitions/StudyDetail'
          headers:
            Last-Modified:
              type: string
              description: Date-time of when the study was last updated
              x-nullable: false
        "401":
          description: Unauthorized.
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: The study was not found.
          schema:
            $ref: '#/definitions/Error'
        "451":
          description: Unavailable for legal reasons.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
    delete:
      tags:
        - Study
      summary: 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.
      operationId: deleteStudy
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: path
          description: The study to delete.
          name: studyId
          type: string
      responses:
        "204":
          description: Success.
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: The study was not found.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
    patch:
      tags:
        - Study
      summary: 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.
      operationId: patchStudy
      produces:
        - application/json
      consumes:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: path
          description: The study to be updated.
          name: studyId
          type: string
          x-nullable: false
        - description: The patches to apply to the study. Only "replace" operation is supported.
          name: patches
          in: body
          required: true
          schema:
            $ref: '#/definitions/PatchReq'
      responses:
        "200":
          description: Study updated successfully.
          schema:
            $ref: '#/definitions/Study'
        "400":
          description: The supplied study information is invalid.
          schema:
            $ref: '#/definitions/Error'
        "401":
          description: Unauthorized.
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: The study was not found.
          schema:
            $ref: '#/definitions/Error'
        "451":
          description: The study is not legally compliant
          schema:
            $ref: '#/definitions/NonCompliantStudy'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /v1/kpos:
    get:
      tags:
        - kpos
      summary: 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.
      operationId: getKpos
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: query
          description: The study which KPOs belongs to.
          name: studyId
          type: string
          x-nullable: false
      responses:
        "200":
          description: Retrieved KPOs successfully.
          schema:
            $ref: '#/definitions/KpoCollection'
        "204":
          description: No KPOs in the study were found.
        "401":
          description: Unauthorized.
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: The study was not found.
          schema:
            $ref: '#/definitions/Error'
        "451":
          description: Unavailable for legal reasons.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /v1/scenarios:
    get:
      tags:
        - Scenarios
      summary: 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.
      operationId: getScenarios
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: query
          description: The study which Scenarios/Decisions/Choices belongs to.
          name: studyId
          type: string
          x-nullable: false
      responses:
        "200":
          description: Retrieved scenarios successfully.
          schema:
            $ref: '#/definitions/Scenarios'
        "401":
          description: Unauthorized.
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: The study was not found.
          schema:
            $ref: '#/definitions/Error'
        "451":
          description: Unavailable for legal reasons.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
    post:
      tags:
        - Scenarios
      summary: 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.
      operationId: postScenario
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: query
          description: The study in which scenario will be created.
          name: studyId
          type: string
          x-nullable: false
        - description: The scenario that needs to be created.
          name: scenario
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateScenarioRequest'
      responses:
        "201":
          description: Scenario created successfully.
          schema:
            $ref: '#/definitions/Scenario'
          headers:
            Location:
              type: string
              description: The URL of the scenario.
              x-nullable: false
        "400":
          description: Bad request
          schema:
            $ref: '#/definitions/Error'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: The studyID was not found.
          schema:
            $ref: '#/definitions/Error'
        "409":
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        "451":
          description: Unavailable for legal reasons
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
    delete:
      tags:
        - Scenarios
      summary: Delete a scenario
      description: |
        Deletes the scenario identified by scenarioId from the given study,
        together with its ensemble and the results associated with it.
      operationId: deleteScenario
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: query
          description: The study to which the scenario belongs.
          name: studyId
          type: string
          x-nullable: false
        - required: true
          in: query
          description: The id of the scenario to delete.
          name: scenarioId
          type: string
          x-nullable: false
      responses:
        "204":
          description: Successful deletion.
        "400":
          description: Invalid scenarioID or studyID.
          schema:
            $ref: '#/definitions/Error'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: The scenario to delete does not exist.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
    patch:
      tags:
        - Scenarios
      summary: 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.
      operationId: patchScenario
      produces:
        - application/json
      consumes:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: query
          description: The study id which the scenario belong to.
          name: studyId
          type: string
          x-nullable: false
        - required: true
          in: query
          description: The id of the scenario to update.
          name: scenarioId
          type: string
          x-nullable: false
        - description: The patches to apply to the scenario. Only "replace" operation is supported.
          name: patches
          in: body
          required: true
          schema:
            $ref: '#/definitions/PatchReq'
      responses:
        "200":
          description: Scenario updated successfully.
          schema:
            $ref: '#/definitions/Scenario'
        "400":
          description: The supplied scenario information is invalid.
          schema:
            $ref: '#/definitions/Error'
        "401":
          description: Unauthorized.
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: The scenario was not found.
          schema:
            $ref: '#/definitions/Error'
        "451":
          description: Unavailable for legal reasons.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /v1/scenarios/results-state:
    get:
      tags:
        - Results
      summary: 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.
      operationId: getScenarioResultsState
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: query
          description: The study from which to get the results state.
          name: studyId
          type: string
          x-nullable: false
        - required: true
          in: query
          description: The scenario from which to get the results state.
          name: scenarioId
          type: string
          x-nullable: false
      responses:
        "200":
          description: Success.
          schema:
            $ref: '#/definitions/ScenarioResultsState'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: Either the studyId or the scenarioId was not found, or the scenario is not part of the study.
          schema:
            $ref: '#/definitions/Error'
        "451":
          description: Unavailable for legal reasons
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /v1/deliverables:
    get:
      tags:
        - Deliverables
      summary: 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.
      operationId: getDeliverables
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: query
          description: The study which the deliverables belong to.
          name: studyId
          type: string
          x-nullable: false
        - in: query
          description: The optional scenario which the deliverables belong to. If not specified all deliverables for given study will be returned.
          name: scenarioId
          type: string
          x-nullable: false
      responses:
        "200":
          description: Retrieved deliverables successfully.
          schema:
            $ref: '#/definitions/Deliverables'
        "204":
          description: No deliverables in the study were found.
        "401":
          description: Unauthorized.
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: The study was not found.
          schema:
            $ref: '#/definitions/Error'
        "451":
          description: Unavailable for legal reasons.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /v1/deliverables/{deliverableId}:
    get:
      tags:
        - Deliverables
      summary: 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.
      operationId: getDeliverable
      produces:
        - application/json
      consumes:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: query
          description: The study which the deliverable belongs to.
          name: studyId
          type: string
          x-nullable: false
        - required: true
          in: path
          description: The ID of the deliverable to get.
          name: deliverableId
          type: string
          x-nullable: false
      responses:
        "200":
          description: Deliverable retrieved successfully.
          schema:
            $ref: '#/definitions/DeliverableDetail'
        "400":
          description: Invalid study or deliverable ID.
          schema:
            $ref: '#/definitions/Error'
        "401":
          description: Unauthorized.
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: Not found.
          schema:
            $ref: '#/definitions/Error'
        "451":
          description: Unavailable for legal reasons.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
    patch:
      tags:
        - Deliverables
      summary: 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.
      operationId: patchDeliverable
      produces:
        - application/json
      consumes:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: query
          description: The study which the deliverable belong to.
          name: studyId
          type: string
          x-nullable: false
        - required: true
          in: path
          description: The ID of the deliverable to update.
          name: deliverableId
          type: string
          x-nullable: false
        - 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.
          name: patches
          in: body
          required: true
          schema:
            $ref: '#/definitions/PatchReq'
      responses:
        "200":
          description: Deliverable updated successfully.
          schema:
            $ref: '#/definitions/Deliverable'
        "400":
          description: Bad request.
          schema:
            $ref: '#/definitions/Error'
        "401":
          description: Unauthorized.
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: The deliverable was not found.
          schema:
            $ref: '#/definitions/Error'
        "451":
          description: Unavailable for legal reasons.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /v1/opportunities:
    get:
      tags:
        - Opportunities
      summary: 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.
      operationId: getOpportunities
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: query
          description: The study
          name: studyId
          type: string
          x-nullable: false
        - in: query
          description: The number of the page in the list of Opportunities
          name: pageNumber
          type: integer
          default: 0
          x-nullable: false
        - in: query
          description: The number of Opportunities per page
          name: pageSize
          type: integer
          default: 100
          maximum: !!float 500
          x-nullable: false
      responses:
        "200":
          description: Success.
          schema:
            $ref: '#/definitions/OpportunityCollection'
        "204":
          description: Study contains no opportunities.
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: The studyID was not found.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
  /v1/scenario-ranking-scores:
    get:
      tags:
        - Scores
      summary: 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.
      operationId: getScores
      consumes:
        - application/json
      parameters:
        - $ref: '#/parameters/SlbPartitionId'
        - required: true
          in: query
          description: The ID of the study for which to get the scenario ranking scores
          name: studyId
          type: string
        - in: query
          description: The number of the page in the list of ranking scores.
          name: pageNumber
          type: integer
          default: 0
          x-nullable: false
        - in: query
          description: The number of ranking scores per page.
          name: pageSize
          type: integer
          default: 100
          maximum: !!float 500
          x-nullable: false
        - in: query
          description: Whether to include criteria scores break-down in the response
          name: includeCriteriaScores
          type: boolean
          default: false
          x-nullable: false
      responses:
        "200":
          description: Success.
          schema:
            $ref: '#/definitions/GetScoresResponse'
        "204":
          description: No ranking scores found for given study ID.
        "400":
          description: Bad request.
          schema:
            $ref: '#/definitions/Error'
        "401":
          description: Unauthorized.
          schema:
            $ref: '#/definitions/Error'
        "404":
          description: The studyID was not found.
          schema:
            $ref: '#/definitions/Error'
        "503":
          description: Unavailable
          schema:
            $ref: '#/definitions/Error'
        default:
          description: Unexpected error.
          schema:
            $ref: '#/definitions/Error'
definitions:
  CorrelationId:
    description: The correlation ID for the request.
    type: string
  Error:
    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
            x-nullable: false
          message:
            description: The error message.
            type: string
            example: internal server error
    example:
      data:
        code: 500
        message: internal server error
  NonCompliantStudy:
    required:
      - ID
      - title
      - isArchived
      - isLegallyCompliant
      - version
      - legalTags
    type: object
    properties:
      ID:
        description: The ID of this study. This field is immutable.
        type: string
        x-nullable: false
      title:
        description: The title of this study.
        type: string
        x-nullable: false
      isArchived:
        description: Is the study hidden.
        type: boolean
        x-nullable: false
      isLegallyCompliant:
        description: Always false (all studies in this list are non-compliant)
        type: boolean
        x-nullable: false
      version:
        description: The version of the described study.
        type: integer
        x-nullable: false
      legalTags:
        description: The legal tag(s) for the Study
        type: array
        items:
          $ref: '#/definitions/LegalTag'
      projectID:
        description: The linked project id, if any.
        type: string
        x-nullable: false
      projectName:
        description: The name of the linked project, mandatory if a project is linked.
        type: string
        x-nullable: false
      projectStageID:
        description: The stage id of the linked project, mandatory if a project is linked.
        type: string
        x-nullable: false
      projectStageName:
        description: The name of the linked project stage, mandatory if a project is linked.
        type: string
        x-nullable: false
    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.
  Studies:
    description: A list of studies.
    required:
      - items
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/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
  CreateStudyRequest:
    required:
      - title
      - workflowSpecId
      - workflowSpecVersion
      - acl
    type: object
    properties:
      title:
        description: The title of this study.
        type: string
        x-nullable: false
      description:
        description: The description of this study.
        type: string
        x-nullable: false
      workflowSpecId:
        description: The identifier for the evaluation workflow specification to be used in the study.
        type: string
        x-nullable: false
      workflowSpecVersion:
        format: int32
        description: The identifier for the evaluation workflow specification version to be used in the study.
        minimum: !!float 1
        type: integer
        x-nullable: false
      legalTags:
        description: Names of the Legal Tag(s) that are assigned to the Study.
        type: array
        items:
          type: string
          x-nullable: false
      acl:
        $ref: '#/definitions/Acl'
      evaluationConfiguration:
        $ref: '#/definitions/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
  Study:
    required:
      - id
      - title
      - description
      - country
      - isArchived
    type: object
    properties:
      id:
        description: The ID of this study. This field is immutable.
        type: string
        example: 01CP3E6EJJ25J29YHZ0K4RDZH8
        x-nullable: false
      title:
        description: The title of this study.
        type: string
        example: Robin Field Development
        x-nullable: false
      description:
        description: Description of the study.
        type: string
        example: New development opportunity.
        x-nullable: false
      country:
        description: The country code of this study.
        type: string
        example: US
        x-nullable: false
      isArchived:
        description: Archived status of this study.
        type: boolean
        example: false
        x-nullable: false
      noOfRealizations:
        format: int32
        description: The number of realizations for each study scenario.
        type: integer
        x-nullable: false
      uncertaintyMethod:
        description: Methodology selected for uncertainty
        default: MonteCarlo
        enum:
          - Unset
          - MonteCarlo
          - Deterministic
        type: string
        x-nullable: false
      workflowSpec:
        $ref: '#/definitions/VersionId'
      acl:
        $ref: '#/definitions/Acl'
      evaluationConfiguration:
        $ref: '#/definitions/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
  StudyDetail:
    required:
      - id
      - title
    type: object
    properties:
      id:
        description: The ID of this study. This field is immutable.
        type: string
        example: 01CP3E6EJJ25J29YHZ0K4RDZH8
        x-nullable: false
      title:
        description: The title of this study.
        type: string
        example: Robin Field Development
        x-nullable: false
      stage:
        description: The stage of the study (appraise, select, etc).
        type: string
        example: appraise
        x-nullable: false
      status:
        description: The status of the study.
        type: string
        example: Opportunity Framing
        x-nullable: false
      isArchived:
        description: Is the study hidden.
        type: boolean
        example: false
        x-nullable: false
      finalInvestmentDecisionDate:
        format: date-time
        description: The date of the final investment decision.
        type: string
        example: "2020-09-08T09:53:36.000Z"
        x-nullable: true
      stageEnd:
        format: date-time
        description: The stage end date.
        type: string
        example: "2020-09-08T09:53:36.000Z"
        x-nullable: true
      country:
        description: The country of the study.
        type: string
        example: us
        x-nullable: false
      fieldName:
        description: The name of the field.
        type: string
        example: Robin Field
        x-nullable: false
      fieldEnvironment:
        description: The type of field location. The value Offshore has been deprecated.
        enum:
          - Offshore
          - Onshore
          - Shallow water
          - Deep water
        type: string
        example: Offshore
        x-nullable: false
      fieldType:
        description: Whether or not the field has already been developed.
        enum:
          - Greenfield
          - Brownfield
        type: string
        example: Brownfield
        x-nullable: false
      fieldLocation:
        $ref: '#/definitions/GeoPoint'
      legalTags:
        description: The legal tag(s) for the Study
        type: array
        items:
          $ref: '#/definitions/LegalTag'
      lastUpdated:
        $ref: '#/definitions/LastUpdated'
      deepLink:
        description: Link to the FDPlan overview page for the study.
        type: string
        x-nullable: false
      noOfRealizations:
        format: int32
        description: The number of realizations for each study scenario.
        type: integer
        x-nullable: false
      uncertaintyMethod:
        description: Methodology selected for uncertainty
        default: MonteCarlo
        enum:
          - Unset
          - MonteCarlo
          - Deterministic
        type: string
        x-nullable: false
      workflowSpec:
        $ref: '#/definitions/VersionId'
      acl:
        $ref: '#/definitions/Acl'
      evaluationConfiguration:
        $ref: '#/definitions/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
  EvaluationConfiguration:
    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
        x-nullable: true
  GeoPoint:
    description: A geographical point containing geographic point coordinates.
    type: object
    properties:
      latitude:
        format: double
        description: The latitude. North-South co-ordinate of the location in signed decimal degrees (-90 to +90).
        type: number
        example: 1.2990
        x-nullable: true
      longitude:
        format: double
        description: The longitude. East-West co-ordinate of the location in signed decimal degrees (-180 to +180).
        type: number
        example: 1.2990
        x-nullable: true
    example:
      latitude: 1.2990
      longitude: 51.6224
  LegalTag:
    description: A legal tag.
    required:
      - name
    type: object
    properties:
      name:
        description: The name of the Legal Tag.
        type: string
        example: public-usa-dataset-1
        x-nullable: false
      description:
        description: The description of the Legal Tag.
        type: string
        example: A LegalTag used for demonstration purposes.
        x-nullable: false
    example:
      name: public-usa-dataset-1
      description: A LegalTag used for demonstration purposes.
  Scenarios:
    description: A list of scenarios.
    required:
      - items
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/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
  CreateScenarioRequest:
    required:
      - title
    type: object
    properties:
      title:
        description: The title of this scenario.
        maxLength: 100
        type: string
        x-nullable: false
      colour:
        description: AA-friendly colour for scenario. Specified as hex, e.g '#FFA71A'.
        pattern: ^#([A-Fa-f0-9]{6})$|^$
        type: string
        x-nullable: false
      description:
        description: The description of this scenario.
        maxLength: 500
        type: string
        x-nullable: false
      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
        x-nullable: false
      associatedOpportunityIDs:
        type: array
        items:
          description: The opportunity ids which are associated with this scenario.
          type: string
        x-nullable: true
    example:
      title: Minimal investment
      colour: '#ff0000'
      description: Minimal investment development option scenario.
      isSelected: false
      associatedOpportunityIDs:
        - 01CP3E6EJJ25J29YHZ0K4ANABC
        - 01CP3E6EJJ25J29YHZ0K4ANDEF
  Scenario:
    description: A Study's scenarios.
    type: object
    properties:
      id:
        description: A scenario's unique identifier.
        type: string
        example: 01CP3E6EJJ25J29YHZ0K4RDZH8
        x-nullable: false
      displayID:
        description: The user-friendly ID of this scenario.
        type: string
        example: S1
        x-nullable: false
      ensembleID:
        description: The ID of the ensemble that manages all the realizations associated with the scenario.
        type: string
        x-nullable: false
      title:
        description: A scenario's title.
        type: string
        example: Minimal investment
        x-nullable: false
      description:
        description: The description of this scenario.
        type: string
        example: Minimal investment development option scenario.
        x-nullable: false
      lastUpdated:
        $ref: '#/definitions/LastUpdated'
      created:
        $ref: '#/definitions/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
        example: true
        x-nullable: true
      decisions:
        description: The collection of the scenario's decisions.
        type: array
        items:
          $ref: '#/definitions/Decision'
      colour:
        description: The colour of this scenario represented as a HTML hex value (e.g. "#ffa71a").
        type: string
        example: '#ff0000'
        x-nullable: false
      version:
        format: int32
        description: The version of the described scenario.
        type: integer
        x-nullable: true
      associatedDevelopmentConceptId:
        description: The development concept id which is associated with this scenario.
        type: string
        example: 01CP3E6EJJ25J29YHZ0K4ANIH8
        x-nullable: true
      associatedOpportunityIDs:
        type: array
        items:
          description: The opportunity ids which are associated with this scenario.
          type: string
        x-nullable: true
    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
  ScenarioResultsState:
    required:
      - realizationStates
      - dataSourceProcessingState
      - resultsPublishingState
    type: object
    properties:
      dataSource:
        $ref: '#/definitions/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
        x-nullable: false
      lastUpdated:
        format: date-time
        description: The time when the scenario result state was last updated.
        type: string
        example: "2020-09-08T09:53:36.000Z"
        x-nullable: true
      realizationStates:
        description: A list of realizations with corresponding states.
        type: array
        items:
          $ref: '#/definitions/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
        x-nullable: false
    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
  RealizationState:
    required:
      - uri
      - version
      - state
    type: object
    properties:
      uri:
        description: The URI of the realization
        type: string
        x-nullable: false
      version:
        format: int32
        description: Version of the realization.
        type: integer
        example: 4
        x-nullable: false
      state:
        description: State of the realization.
        enum:
          - Unknown
          - InsufficientData
          - Running
          - CompletedSuccessfully
          - CompletedWithErrors
          - Stopping
          - Stopped
        type: string
        example: CompletedWithErrors
        x-nullable: false
      lastUpdatedAt:
        format: date-time
        description: The time when the realization was last updated.
        type: string
        example: "2021-02-10T11:12:14.000Z"
        x-nullable: true
      resultsErrors:
        type: array
        items:
          $ref: '#/definitions/ResultsError'
      computationStates:
        description: List of computation run states.
        type: array
        items:
          $ref: '#/definitions/ComputationState'
  ResultsError:
    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
        x-nullable: false
      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: '#/definitions/SpecAddress'
  SpecAddress:
    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
        x-nullable: false
      computationIndex:
        description: The zero based index of the Computation Spec.
        type: integer
        example: 0
        x-nullable: false
      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
        x-nullable: false
  ComputationState:
    required:
      - address
      - runState
    type: object
    properties:
      address:
        $ref: '#/definitions/SpecAddress'
      runState:
        description: The run state of the computation.
        enum:
          - Unknown
          - InsufficientData
          - Running
          - CompletedSuccessfully
          - CompletedWithErrors
          - Stopping
          - Stopped
        type: string
        example: CompletedWithErrors
        x-nullable: false
      errors:
        description: A list of computation errors.
        type: array
        items:
          $ref: '#/definitions/ComputationError'
  ComputationError:
    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
        x-nullable: false
      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: '#/definitions/SpecAddress'
  CreateKpiRequest:
    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
        x-nullable: false
      type:
        description: The value type of KPI.
        enum:
          - Money
          - Percentage
          - Date
          - Years
          - Ratio
          - Volume
          - Dimensionless
        type: string
        example: Money
        x-nullable: false
      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
        x-nullable: false
      unit:
        description: The unit of the KPI.
        maxLength: 50
        type: string
        example: M$
        x-nullable: false
      priority:
        format: int64
        description: The priority of the KPI. Increasing value indicates lower priority.
        minimum: !!float 1
        type: integer
        example: 11
      archived:
        description: Whether this KPI has been marked as archived.
        type: boolean
        example: false
        x-nullable: false
      measurement:
        description: The measurement for this KPI.
        pattern: ^[\w\-\.]+:reference-data\-\-UnitOfMeasure:[\w\-\.\:\%]+:[0-9]*$
        type: string
        x-nullable: false
    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:'
  Kpi:
    allOf:
      - $ref: '#/definitions/CreateKpiRequest'
      - required:
          - name
        type: object
        properties:
          name:
            description: The name of this KPI. This field is immutable.
            type: string
            example: First Year Capex
            x-nullable: false
          isSystem:
            description: Defines if the KPI is a system KPI.
            type: boolean
            example: false
            x-nullable: false
          lastUpdated:
            $ref: '#/definitions/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
  Decision:
    description: A Scenario's decision.
    type: object
    properties:
      id:
        description: Decision's unique identifier.
        type: string
        example: 01CP3E6EJJ25J29YHZ0K4RDZH8
        x-nullable: false
      title:
        description: A decision's title.
        type: string
        example: A development decision
        x-nullable: false
      Choice:
        $ref: '#/definitions/Choice'
      description:
        description: Description of this decision.
        type: string
        example: A development decision to be made.
        x-nullable: false
    example:
      id: 01CP3E6EJJ25J29YHZ0K4RDZH8
      title: A development decision
  Choice:
    description: A possible option for a given decision.
    type: object
    properties:
      id:
        description: Choice's unique identifier.
        type: string
        example: 01CP3E6EJJ25J29YHZ0K4RDZH8
        x-nullable: false
      title:
        description: A choice's displayed title.
        type: string
        example: A development choice
        x-nullable: false
      description:
        description: Description of this choice.
        type: string
        example: A development choice to be made.
        x-nullable: false
    example:
      id: 01CP3E6EJJ25J29YHZ0K4RDZH8
      title: A development decision
      description: A development choice to be made.
  KpiCollection:
    required:
      - items
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/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
  Deliverables:
    description: A list of deliverables.
    required:
      - items
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/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
  Deliverable:
    description: A study deliverable.
    required:
      - id
      - attachmentType
      - title
      - status
    type: object
    properties:
      id:
        description: Deliverable's unique identifier.
        type: string
        example: 01CKXHZPAEERP06F3CNKBAPE0F
        x-nullable: false
      title:
        description: The title of the deliverable.
        type: string
        example: Decline Curves
        x-nullable: false
      description:
        description: The description of this deliverable.
        type: string
        example: Decline curves for Robin field.
        x-nullable: false
      status:
        description: The status of the deliverable.
        enum:
          - New
          - Requested
          - In Progress
          - Pending Approval
          - Approved
        type: string
        example: Requested
        x-nullable: false
      attachmentType:
        description: The FDPlan data-type ID for this deliverable's attachment.
        type: string
        example: decline-curves
        x-nullable: false
      attachmentTypeVersion:
        description: The FDPlan data-type version for this deliverable's attachment.
        type: integer
        example: 1
        x-nullable: false
      attachmentSpecAddress:
        $ref: '#/definitions/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
        x-nullable: false
      associatedScenarioId:
        description: The ID of the scenario associated with this deliverable.
        type: string
        example: 01CKXHZPAEERP06F3CNKBAPE0F
        x-nullable: false
      contributors:
        description: A list of the IDs of users marked as contributing to this deliverable.
        type: array
        items:
          type: string
          x-nullable: false
        example:
          - user1@slb.com
          - user2@slb.com
      dataSource:
        $ref: '#/definitions/VersionId'
    example:
      id: 01CKXHZPAEERP06F3CNKBAPE0F
      title: title
      description: description
      status: Requested
      attachmentType: decline-curves
      attachmentTypeVersion: 1
  DeliverableDetail:
    description: Details of a study deliverable.
    required:
      - id
    type: object
    properties:
      id:
        description: Deliverable's unique identifier.
        type: string
        example: 01CKXHZPAEERP06F3CNKBAPE0F
        x-nullable: false
      title:
        description: The title of the deliverable.
        type: string
        example: Decline Curves
        x-nullable: false
      description:
        description: The description of this deliverable.
        type: string
        example: Decline curves for Robin field.
        x-nullable: false
      status:
        description: The status of the deliverable.
        enum:
          - New
          - Requested
          - In Progress
          - Pending Approval
          - Approved
        type: string
        example: Requested
        x-nullable: false
      attachmentType:
        description: The FDPlan data-type ID for this deliverable's attachment.
        type: string
        example: decline-curves
        x-nullable: false
      attachmentTypeVersion:
        description: The FDPlan data-type version for this deliverable's attachment.
        type: integer
        example: 1
        x-nullable: false
      attachmentSpecAddress:
        $ref: '#/definitions/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
        x-nullable: false
      associatedScenarioId:
        description: The ID of the scenario associated with this deliverable.
        type: string
        example: 01CKXHZPAEERP06F3CNKBAPE0F
        x-nullable: false
      contributors:
        description: A list of the IDs of users marked as contributing to this deliverable.
        type: array
        items:
          type: string
          x-nullable: false
        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
          x-nullable: false
        example:
          - user3@slb.com
      dueDate:
        format: date-time
        description: The date by which the deliverable must be Approved
        type: string
        example: "2020-09-08T09:53:36.000Z"
        x-nullable: true
      lastUpdated:
        $ref: '#/definitions/LastUpdated'
      attachmentLastUpdated:
        $ref: '#/definitions/LastUpdated'
      dataSource:
        $ref: '#/definitions/VersionId'
    example:
      id: 01CKXHZPAEERP06F3CNKBAPE0F
      title: title
      description: Decline curves for Robin field.
      status: Requested
      attachmentType: decline-curves
      attachmentTypeVersion: 1
  LastUpdated:
    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
        x-nullable: false
      atDate:
        format: date-time
        description: The date time of the last update.
        type: string
        example: "2020-09-08T09:53:36.000Z"
        x-nullable: true
      byEvent:
        $ref: '#/definitions/CorrelationId'
    example:
      atDate: "2020-09-08T09:53:36.000Z"
      byEvent: 01EHPJ54HEA77K95T5KPH5JSW9
      byUser: user@slb.com
  Created:
    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
        x-nullable: false
      atDate:
        format: date-time
        description: The date and time the resource was created.
        type: string
        example: "2020-09-08T09:53:36.000Z"
        x-nullable: true
      byEvent:
        $ref: '#/definitions/CorrelationId'
    example:
      atDate: "2020-09-08T09:53:36.000Z"
      byEvent: 01EHPJ54HEA77K95T5KPH5JSW9
      byUser: user@slb.com
  PatchReq:
    description: A list of patch items.
    type: array
    items:
      $ref: '#/definitions/PatchItem'
    example:
      - op: replace
        path: title
        value: title
      - op: replace
        path: description
        value: description
  PatchItem:
    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
        x-nullable: false
      path:
        description: A JSON-Pointer.
        type: string
        example: description
        x-nullable: false
      value:
        description: The value to be used within the operations.
        example: New description
      from:
        description: A string containing a JSON Pointer value.
        type: string
        x-nullable: false
    example:
      op: replace
      path: description
      value: New description
  KpoCollection:
    description: A list of KPOs.
    required:
      - items
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/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$
  Kpo:
    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
        x-nullable: false
      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
        x-nullable: false
      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"
        x-nullable: false
      description:
        description: The description of this KPO.
        type: string
        example: After Tax Maximum Exposure
        x-nullable: false
      type:
        description: The value type of this KPO.
        enum:
          - Money
          - Percentage
          - Date
          - Years
          - Ratio
          - Volume
          - Dimensionless
        type: string
        example: Money
        x-nullable: false
      unit:
        description: The unit of the KPO.
        type: string
        example: M$
        x-nullable: false
    example:
      name: ATMaxEx
      description: After Tax Maximum Exposure
      objectiveOperator: Less Than
      objectiveValue: "600"
      type: Money
      unit: M$
  VersionId:
    description: A versioned resource identifier.
    required:
      - id
      - version
    type: object
    properties:
      id:
        description: The resource ID.
        type: string
        example: 01CP3E6EJJ25J29YHZ0K4RDZH8
        x-nullable: false
      version:
        description: The version of resource.
        type: integer
        example: 1
        x-nullable: false
    example:
      id: 01CP3E6EJJ25J29YHZ0K4RDZH8
      version: 1
  OpportunityCollection:
    required:
      - items
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/Opportunity'
  Opportunity:
    required:
      - ID
      - title
      - type
    type: object
    properties:
      ID:
        description: The ID of this opportunity. This field is immutable.
        type: string
        x-nullable: false
      title:
        description: The title of this opportunity.
        type: string
        x-nullable: false
      displayID:
        description: The user-friendly ID of this opportunity. This field is immutable.
        type: string
        x-nullable: false
      type:
        description: The type of opportunity.
        enum:
          - Base
          - Opportunity
        type: string
        x-nullable: false
      associatedBaseID:
        description: The ID of the associated base opportunity.
        type: string
        x-nullable: false
      opportunityRegisterDetails:
        $ref: '#/definitions/OpportunityRegisterDetails'
  Acl:
    title: Access Control List
    description: The access control list.
    required:
      - owners
      - viewers
    additionalProperties: false
    type: object
    properties:
      owners:
        title: List of Owners
        description: "The list of owners of this resource formatted as an email. By\nconvention owner data groups must begin with the prefix `data.`.\nValidation rules:\n  1. Only owner data groups formatted as emails are allowed here.\n  2. Owner data groups must begin with the prefix `data.`.\n  3. All `owners` data groups must have a corresponding valid `viewers` data group pair\n    in the `viewers` property to ensure proper access control. \n"
        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: |
          The list of viewers to which this resource is accessible/visible/discoverable
          formatted as an email. By convention viewer data groups must begin
          with the prefix `data.`.
          Validation rules:
            1. Only viewer data groups formatted as emails are allowed here.
            2. Viewer data groups must begin with the prefix `data.`.
            3. Parity check: All `viewers` data groups must be valid pairs for their respective `owners`
              data groups to ensure proper access control.
        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
  OpportunityRegisterDetails:
    type: object
    properties:
      registerID:
        description: The ID of the associated opportunity in the register.
        type: string
        x-nullable: true
      registerVersion:
        format: int64
        description: The version of the associated opportunity in the register.
        minimum: !!float 1
        type: integer
        x-nullable: true
  GetScoresResponse:
    description: Response to get ranking scores.
    required:
      - items
    type: object
    properties:
      items:
        description: The ranking scores.
        type: array
        items:
          $ref: '#/definitions/ScenarioScore'
  ScenarioScore:
    description: Ranking score of a scenario.
    required:
      - scenarioId
      - score
      - scoreVersion
    type: object
    properties:
      scenarioId:
        description: ID of the scenario
        type: string
        x-nullable: false
      score:
        format: double
        description: The score of the scenario.
        type: number
        x-nullable: false
      scoreVersion:
        format: int32
        description: Version of the scenario score
        type: number
        x-nullable: false
      criteriaScores:
        description: The scores of the criteria.
        type: array
        items:
          $ref: '#/definitions/CriterionScore'
        x-omitempty: true
  CriterionScore:
    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
        x-nullable: false
      version:
        format: int32
        description: Version of the criterion
        type: number
        x-nullable: false
      score:
        format: double
        description: The score of the criterion.
        type: number
        x-nullable: false
      weight:
        format: double
        description: The weight of the criterion score.
        type: number
        x-nullable: false
parameters:
  SlbPartitionId:
    required: true
    in: header
    description: Data partition id.
    name: slb-partition-id
    type: string
security:
  - bearer: []
    appkey: []
securityDefinitions:
  bearer:
    type: apiKey
    name: Authorization
    in: header
  appkey:
    type: apiKey
    name: appkey
    in: header
tags:
  - name: Kpis
    description: Manage Key Performance Indicators (KPIs).
  - name: Studies
    description: Manage studies.
  - name: Study
    description: Manage individual studies.
  - name: kpos
    description: Manage Key Performance Objectives (KPOs).
  - name: Scenarios
    description: Manage scenarios.
  - name: Results
    description: Manage results.
  - name: Deliverables
    description: Manage deliverables.
  - name: Opportunities
    description: Manage opportunities.
  - name: Scores
    description: Manage scenario ranking scores.