# ProspectAnalysisAggregationDto

Schema: #/components/schemas/ProspectAnalysisAggregationDto

Method: SCHEMA
Version: 1
Security: bearer, appkey

## Schema fields:

  - `id` (integer)
    The ID of the analysis aggregation.

  - `name` (string)
    The name of the analysis aggregation.

  - `modifiedDate` (string)
    The date the analysis aggregation was last modified.

  - `modifiedUserName` (string)
    The user name of the person who last modified the analysis aggregation.

  - `modifiedRealName` (string)
    The real name of the user who most recently modified the analysis aggregation.

  - `createdDate` (string)
    The date the analysis aggregation was created.

  - `createdUserName` (string)
    The user name of the person creating the analysis aggregation.

  - `createdRealName` (string)
    The real name of the user who created the analysis aggregation.

  - `prospectId` (integer)
    The prospect folder ID.

  - `prospectName` (string)
    The prospect name.

  - `version` (string)
    The version of the prospect analysis aggregation.
Permitted values are approved (A), historic (H), working (W) and test (T).

  - `useHcPhaseRisking` (boolean)
    True if at least one enrolled analysis uses hydrocarbon phase risking.

  - `input` (object)
    A data transfer object (DTO) representing input settings for aggregating analyses.

  - `input.resourceLimits` (object)
    A data transfer object (DTO) representing resource limits for aggregation.

  - `input.resourceLimits.useScreeningThreshold` (boolean)
    Indicate if the above screening threshold resource limit was set.

  - `input.resourceLimits.hcType` (string)
    The hydrocarbon type list [Oil, NonAssoc.Gas, Assoc.Gas, Condensate, or Total Resources] defines
the fluid basis for defining a success case's minimum recoverable volume.

  - `input.resourceLimits.volume` (number)
    Defines a minimum economic recoverable volume.
The screening threshold estimates a probability for a discovery above the screening threshold.

  - `analysisResult` (object)
    A data transfer object (DTO) representing prospect analysis aggregation.

  - `analysisResult.successDiscovery` (number)
    The likelihood of finding hydrocarbons.

  - `analysisResult.aboveScreeningThreshold` (number)
    The likelihood of finding greater volumes of hydrocarbons than a threshold value.

  - `analysisResult.wellPath` (number)
    The likelihood of finding hydrocarbons when drilling along this well path.

  - `analysisResult.results` (object)
    The aggregated analysis result parameters, organized by result parameter name.

  - `analysisResult.oilOnly` (number)
    The probability that the prospect contains hydrocarbon, but oil only (i.e. no gas).

  - `analysisResult.gasOnly` (number)
    The probability that the prospect contains hydrocarbon, but gas only (i.e. no oil).

  - `analysisResult.oilAndGas` (number)
    The probability that the prospect contains hydrocarbon, both oil and gas.

  - `analysisResult.dfiRiskSummaries` (array)
    A collection of Direct Fluid Indicator (DFI) risk summaries.

  - `analysisResult.dfiRiskSummaries.enrolledAnalysisId` (integer)
    The enrolled analysis ID (like segment analysis).

  - `analysisResult.dfiRiskSummaries.initial` (number)
    The initial DFI risk value.

  - `analysisResult.dfiRiskSummaries.standAloneWithDFI` (number)
    The DFI risk value if this is a stand-alone analysis.

  - `analysisResult.dfiRiskSummaries.inProspectWithDFI` (number)
    The DFI risk value if this is an analysis enrolled in a prospect analysis.

  - `properties` (object)
    The properties of the prospect analysis aggregation.

  - `folderDetails` (object)
    A data transfer object (DTO) representing the collection of parent basin and play folders of an aggregated folder.

  - `folderDetails.basins` (array)
    Aggregated parent basin folders.

  - `folderDetails.basins.id` (integer, required)
    The unique identifier.

  - `folderDetails.basins.name` (string)
    The name of the folder (basin, play, segment or prospect).

  - `folderDetails.plays` (array)
    Aggregated parent play folders.

  - `crsId` (integer)
    The coordinate reference system ID (EPSG number, like: 4326).

  - `innerRings` (array)
    The list of holes in the polygon representing this prospect (optional).

  - `outerRing` (string)
    The outer ring of the polygon representing this prospect.
If there is a polygon data, this has to be filled.

  - `entitlements` (array)
    The entitlements of the enrolled analyses.

  - `entitlements.licenseId` (integer)
    The license ID.

  - `entitlements.label` (string)
    The license label.

  - `entitlements.segmentId` (integer)
    The segment (folder) ID.

  - `entitlements.segmentName` (string)
    The segment (folder) name.

  - `entitlements.licenseVersion` (integer)
    The license version.

  - `entitlements.block` (string)
    The block name.

  - `entitlements.wiShare` (number)
    The working interest share.
The owner interest = WiShare * NetShare.

  - `entitlements.netShare` (number)
    The net factor (share).
The owner interest = WiShare * NetShare.

  - `entitlements.useOilEquivalentsCoverage` (boolean)
    Indicates whether or not oil equivalents coverage was set.

  - `entitlements.useMultipleFactor` (boolean)
    Indicates whether or not to use probabilities instead of one single factor.

  - `entitlements.oilEquivalentsSingleFactor` (number)
    Contain Oil Equivalents coverage value only if UseOilEquivalentsCoverage is set (true) and use details is false. (Factor column in SEG/DRY/DIS_BLOCK_COVERAGE table)

  - `entitlements.analysisId` (integer)
    The unique identifier of the enrolled analysis.

  - `entitlements.analysisName` (string)
    The name of the enrolled analysis.

  - `entitlements.analysisType` (string)
    The enrolled analysis type.

  - `risks` (array)
    The risks of the enrolled analyses.

  - `risks.identifier` (string)
    Risk identifier.

  - `risks.probability` (number)
    Risk probability (between 0 and 1), 0 means absolute certainty that a condition fails.

  - `risks.name` (string)
    Risk name.

  - `risks.justification` (string)
    Justification text.

  - `risks.type` (string)
    Risk type (like: segment, play, hc, dhi). Can be null.

  - `risks.category` (string)
    Risk category

  - `risks.segmentId` (integer)
    Segment id

  - `risks.segmentName` (string)
    Segment name (analysis parent)