The prospect object can contain the analysis created for assessment of hydrocarbon resource potential and geological risk of finding these volumes. The prospect analysis contains links to one or more enrolled segment analysis, which make up the parts of the former based on geological properties.
The aggregation endpoints offer summary views that include key property information and results in terms of risk, resource and value of multiple linked analyses.
\n\n\n```plain {% title=\"Client ID\" %}\nedf17d1f8cc3461d8ba3f1a98ce7be1b\n```", "version": "1", "x-product-id": "Opportunity-Assessor", "contact": { "name": "Opportunity Assessor / GeoX team", "url": "https://customersupport.digital.slb.com/cs" } }, "servers": [ { "url": "https://eu-api.delfi.slb.com/spar" } ], "paths": { "/assessments/v1/licenseaggregation/{id}": { "get": { "tags": [ "LicenseAggregation" ], "summary": "Get license aggregation data for all versions by license ID", "description": "Returns the license aggregation data for all versions by license ID.\nThis includes block(s), nation, licensees and lists all prospects linked to the license:\nEach prospect listed includes information about geological risk together with their gross and net resources in the license.", "operationId": "PublicGetAllLicenseAggregationVersions", "parameters": [ { "name": "id", "in": "path", "description": "License ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "slb-contract-id", "in": "header", "description": "Delfi Contract ID", "required": true, "schema": { "pattern": "^[a-zA-Z0-9_-]+$", "type": "string", "description": "Delfi contract ID", "example": "My-contract-ID" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseAggregationDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseAggregationDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseAggregationDto" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/assessments/v1/prospectanalysisaggregation/{id}": { "get": { "tags": [ "ProspectAnalysisAggregation" ], "summary": "Get prospect analysis aggregate report by prospect analysis ID", "description": "Gets prospect analysis aggregate report by prospect analysis ID.\nThe report contains chance of success and resource volumes for the prospect analysis, \nthe enrolled segment level risks and resource volumes,\nas well as information about associated folders, polygon, and entitlement (block/license).", "operationId": "PublicGetProspectAnalysisAggregationByProspectAnalysisId", "parameters": [ { "name": "id", "in": "path", "description": "Prospect analysis ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "slb-contract-id", "in": "header", "description": "Delfi Contract ID", "required": true, "schema": { "pattern": "^[a-zA-Z0-9_-]+$", "type": "string", "description": "Delfi contract ID", "example": "My-contract-ID" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProspectAnalysisAggregationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProspectAnalysisAggregationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProspectAnalysisAggregationDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/assessments/v1/prospectanalysisaggregation/{id}/details": { "get": { "tags": [ "ProspectAnalysisAggregation" ], "summary": "Get segment analysis enrolled in prospect analysis by prospect analysis ID", "description": "Gets segment analysis enrolled in prospect analysis by prospect analysis ID.\nThis returns enrolled segment analysis name, properties, chance of success, resource volumes\nand entitlement (block/license) information linked to these segments.", "operationId": "GetProspectAnalysisDetailsForDeveloperPortalByProspectAnalysisId", "parameters": [ { "name": "id", "in": "path", "description": "Prospect analysis ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "slb-contract-id", "in": "header", "description": "Delfi Contract ID", "required": true, "schema": { "pattern": "^[a-zA-Z0-9_-]+$", "type": "string", "description": "Delfi contract ID", "example": "My-contract-ID" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProspectAnalysisDetailsAggregationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProspectAnalysisDetailsAggregationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProspectAnalysisDetailsAggregationDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/assessments/v1/prospectmultiplescenarioanalysisaggregation/{id}": { "get": { "tags": [ "ProspectMultipleScenarioAnalysisAggregation" ], "summary": "Get prospect multiple scenario analysis set-up and results by ID", "description": "Gets prospect multiple scenario analysis set-up, volume and risk results, scenario outcome tree and associated\npolygon by prospect multiple scenario analysis ID.", "operationId": "GetProspectMultipleScenarioAnalysisAggregationByAnalysisForDeveloperPortalId", "parameters": [ { "name": "id", "in": "path", "description": "Prospect multiple scenario analysis ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "slb-contract-id", "in": "header", "description": "Delfi Contract ID", "required": true, "schema": { "pattern": "^[a-zA-Z0-9_-]+$", "type": "string", "description": "Delfi contract ID", "example": "My-contract-ID" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProspectMultipleScenarioAnalysisAggregationDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProspectMultipleScenarioAnalysisAggregationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProspectMultipleScenarioAnalysisAggregationDto" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/assessments/v1/fullcycleanalysisaggregation": { "post": { "tags": [ "FullCycleAnalysisAggregation" ], "summary": "Get aggregated results for all full cycle analyses associated with a prospect analysis by its ID", "description": "Gets hydrocarbon flows, cumulative hydrocarbon production volumes, and economic performance\nindicators on each of the project, contractor and working interest level for all full cycle\nanalyses associated with a prospect analysis by parent prospect analysis ID.", "operationId": "GetFullCycleAnalysisAggregationByProspectAnalysisIdForDeveloperPortal", "parameters": [ { "name": "slb-contract-id", "in": "header", "description": "Delfi Contract ID", "required": true, "schema": { "pattern": "^[a-zA-Z0-9_-]+$", "type": "string", "description": "Delfi contract ID", "example": "My-contract-ID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullCycleFilterDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FullCycleFilterDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FullCycleFilterDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FullCycleAnalysisAggregationDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FullCycleAnalysisAggregationDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FullCycleAnalysisAggregationDto" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } } }, "components": { "schemas": { "AggregatedAnalysisPropertyDto": { "type": "object", "properties": { "label": { "type": "string", "description": "The property label." }, "value": { "type": "string", "description": "The property value." }, "propertyType": { "$ref": "#/components/schemas/AnalysisPropertyTypeDto" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing an aggregated analysis property." }, "AggregatedFolderParentsDto": { "type": "object", "properties": { "basins": { "type": "array", "items": { "$ref": "#/components/schemas/FolderBaseHeaderDto" }, "description": "Aggregated parent basin folders." }, "plays": { "type": "array", "items": { "$ref": "#/components/schemas/FolderBaseHeaderDto" }, "description": "Aggregated parent play folders." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing the collection of parent basin and play folders of an aggregated folder." }, "AnalysisAggregationDataWithResultDto": { "type": "object", "properties": { "successDiscovery": { "type": "number", "description": "The likelihood of finding hydrocarbons.", "format": "double", "nullable": true }, "aboveScreeningThreshold": { "type": "number", "description": "The likelihood of finding greater volumes of hydrocarbons than a threshold value.", "format": "double", "nullable": true }, "wellPath": { "type": "number", "description": "The likelihood of finding hydrocarbons when drilling along this well path.", "format": "double", "nullable": true }, "results": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AnalysisAggregationResultDataDto" }, "description": "The aggregated analysis result parameters, organized by result parameter name." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing an aggregated analysis and its results." }, "AnalysisAggregationInputDto": { "type": "object", "properties": { "resourceLimits": { "$ref": "#/components/schemas/ResourceLimitsForAggregationDto" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing input settings for aggregating analyses." }, "AnalysisAggregationResultDataDto": { "type": "object", "properties": { "mean": { "type": "number", "description": "The mean value of the aggregated result parameter.", "format": "double" }, "probabilityValues": { "type": "object", "additionalProperties": {}, "description": "The probability or fractile values of the result parameter.\nCan have 1 or more elements." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing an aggregated result parameter of an analysis." }, "AnalysisLicenseeForAggregationDto": { "type": "object", "properties": { "analysisId": { "type": "integer", "description": "Unique identifier of the analysis", "format": "int32" }, "companyName": { "type": "string", "description": "The company name" }, "netShare": { "type": "number", "description": "The net share of the license owned by the licensee.", "format": "double", "nullable": true }, "wiShare": { "type": "number", "description": "The Working Interest (WI) share of the license owned by the licensee.", "format": "double", "nullable": true }, "wiExpShare": { "type": "number", "description": "The WI exp share", "format": "double", "nullable": true }, "isOwner": { "type": "boolean", "description": "The is owner" }, "isOperator": { "type": "boolean", "description": "True if this licensee is the operator of the license." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing data about an analysis licensee for aggregation." }, "AnalysisPropertyDto": { "type": "object", "properties": { "label": { "type": "string", "description": "The property label." }, "value": { "type": "string", "description": "The property value." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing an analysis property." }, "AnalysisPropertyTypeDto": { "enum": [ "Text", "Date", "Integer", "Float" ], "type": "string", "description": "A data transfer object (DTO) representing analysis property types." }, "BaseAnalysisResultDataDto": { "type": "object", "properties": { "distributionTypeValue": { "type": "integer", "description": "The sample size in the result distribution.", "format": "int32" }, "distributionTypeShortName": { "maxLength": 16, "type": "string", "description": "The short name of the distribution type (StrBeta, Norm, LgTri)." }, "mode": { "type": "number", "description": "The mode value of the result distribution.", "format": "double" }, "mean": { "type": "number", "description": "The mean (average) value of the result distribution.", "format": "double" }, "standardDeviation": { "type": "number", "description": "The standard deviation of the result distribution.", "format": "double" }, "probabilityValues": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "description": "The probability/fractile values of the result distribution." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing analysis result data." }, "DirectFluidIndicatorRiskSummaryDto": { "type": "object", "properties": { "enrolledAnalysisId": { "type": "integer", "description": "The enrolled analysis ID (like segment analysis).", "format": "int32" }, "initial": { "type": "number", "description": "The initial DFI risk value.", "format": "double", "nullable": true }, "standAloneWithDFI": { "type": "number", "description": "The DFI risk value if this is a stand-alone analysis.", "format": "double", "nullable": true }, "inProspectWithDFI": { "type": "number", "description": "The DFI risk value if this is an analysis enrolled in a prospect analysis.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a summary of the direct fluid indicator (DFI) risk." }, "EnrolledAnalysisExtendedRiskDto": { "type": "object", "properties": { "identifier": { "maxLength": 128, "type": "string", "description": "Risk identifier." }, "probability": { "type": "number", "description": "Risk probability (between 0 and 1), 0 means absolute certainty that a condition fails.", "format": "double" }, "name": { "maxLength": 64, "type": "string", "description": "Risk name." }, "justification": { "maxLength": 2000, "type": "string", "description": "Justification text.", "nullable": true }, "type": { "maxLength": 16, "type": "string", "description": "Risk type (like: segment, play, hc, dhi). Can be null.", "nullable": true }, "category": { "maxLength": 32, "type": "string", "description": "Risk category", "nullable": true }, "segmentId": { "type": "integer", "description": "Segment id", "format": "int32" }, "segmentName": { "type": "string", "description": "Segment name (analysis parent)" } }, "additionalProperties": false, "description": "Contain enrolled analysis extended risks" }, "EnrolledSegmentAnalysisEntitlementDto": { "type": "object", "properties": { "licenseId": { "type": "integer", "description": "The license ID.", "format": "int32", "nullable": true }, "label": { "maxLength": 128, "type": "string", "description": "The license label." }, "segmentId": { "type": "integer", "description": "The segment (folder) ID.", "format": "int32" }, "segmentName": { "maxLength": 256, "type": "string", "description": "The segment (folder) name." }, "licenseVersion": { "type": "integer", "description": "The license version.", "format": "int32", "nullable": true }, "block": { "maxLength": 128, "type": "string", "description": "The block name." }, "wiShare": { "type": "number", "description": "The working interest share.\nThe owner interest = WiShare * NetShare.", "format": "double", "nullable": true }, "netShare": { "type": "number", "description": "The net factor (share).\nThe owner interest = WiShare * NetShare.", "format": "double", "nullable": true }, "useOilEquivalentsCoverage": { "type": "boolean", "description": "Indicates whether or not oil equivalents coverage was set." }, "useMultipleFactor": { "type": "boolean", "description": "Indicates whether or not to use probabilities instead of one single factor." }, "oilEquivalentsSingleFactor": { "type": "number", "description": "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)", "format": "double", "nullable": true }, "analysisId": { "type": "integer", "description": "The unique identifier of the enrolled analysis.", "format": "int32" }, "analysisName": { "maxLength": 256, "type": "string", "description": "The name of the enrolled analysis." }, "analysisType": { "type": "string", "description": "The enrolled analysis type." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing an enrolled segment/dry/discovery analysis entitlement." }, "ExtendedFullCycleResultDto": { "type": "object", "properties": { "economicPerformanceIndicators": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BaseAnalysisResultDataDto" }, "description": "The overall economic performance indicators, such as NPV, IRR and PI, over all outcomes." }, "cumulativeHydrocarbonProduction": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BaseAnalysisResultDataDto" }, "description": "The cumulative hydrocarbon production." }, "hcFLowResults": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/HcFlowResultDto" }, "description": "Overall performance indicators such as NPV, IRR and PI over all outcomes." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing the extended set of full cycle result.\nContains hydrocarbon flow results." }, "FolderBaseHeaderDto": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier.", "format": "int32" }, "name": { "maxLength": 256, "minLength": 1, "type": "string", "description": "The name of the folder (basin, play, segment or prospect)." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing folder header data." }, "FullCycleAnalysisAggregationDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier of the Full Cycle analysis.", "format": "int32" }, "name": { "type": "string", "description": "The name of the Full Cycle analysis." }, "modifiedDate": { "type": "string", "description": "The date the Full Cycle analysis was last modified.", "format": "date-time" }, "modifiedUserName": { "type": "string", "description": "The user name of the person last modifying the Full Cycle analysis." }, "modifiedRealName": { "type": "string", "description": "The real name of the person last modifying the Full Cycle analysis." }, "createdDate": { "type": "string", "description": "The date the Full Cycle analysis was created.", "format": "date-time" }, "createdUserName": { "type": "string", "description": "The user name of the person who created the Full Cycle analysis." }, "createdRealName": { "type": "string", "description": "The real name of the person who created the Full Cycle analysis." }, "version": { "type": "string", "description": "The version of the Full Cycle analysis.\nAllowed values are A (approved), H (historical), T (test), W (working)." }, "parentAnalysisId": { "type": "integer", "description": "The unique identifier of the parent analysis.", "format": "int32" }, "parentAnalysisName": { "type": "string", "description": "The name of the parent analysis." }, "parentFolderId": { "type": "integer", "description": "The unique identifier of the parent folder.", "format": "int32" }, "parentFolderName": { "type": "string", "description": "The name of the parent folder." }, "projectResults": { "$ref": "#/components/schemas/FullCycleResultDto" }, "workingInterestResults": { "$ref": "#/components/schemas/ExtendedFullCycleResultDto" }, "contractorResults": { "$ref": "#/components/schemas/ExtendedFullCycleResultDto" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a Full Cycle analysis aggregation." }, "FullCycleFilterDto": { "type": "object", "properties": { "version": { "type": "string", "description": "The analysis version to filter.\nAllowed values are: A (approved), H (historic), W (working), T (test).\nOptional.", "nullable": true }, "parentIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The list of parent (prospect) analysis IDs to select.\nOptional." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a full cycle analysis filter." }, "FullCycleResultDto": { "type": "object", "properties": { "economicPerformanceIndicators": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BaseAnalysisResultDataDto" }, "description": "The overall economic performance indicators, such as NPV, IRR and PI, over all outcomes." }, "cumulativeHydrocarbonProduction": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/BaseAnalysisResultDataDto" }, "description": "The cumulative hydrocarbon production." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing the results of a full cycle analysis." }, "HcFlowResultDto": { "type": "object", "properties": { "mean": { "type": "number", "description": "The mean (average) value.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing hydrocarbon (HC) flow result." }, "HistoryWithRealNameDto": { "type": "object", "properties": { "modifiedDate": { "type": "string", "description": "The date the object was last modified.", "format": "date-time" }, "userName": { "type": "string", "description": "The user name of the user who last changed the data." }, "description": { "type": "string", "description": "The change description", "nullable": true }, "realName": { "type": "string", "description": "The real name of the user who changed the data." } }, "additionalProperties": false, "description": "A data transfer object representing the creation and modification history of an object." }, "LicenseAggregationDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique id", "format": "int32" }, "label": { "maxLength": 64, "type": "string", "description": "The label" }, "version": { "type": "integer", "description": "The version of the license.", "format": "int32" }, "startDate": { "type": "string", "description": "The date from which the license is valid.", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "The date the license expires.", "format": "date-time", "nullable": true }, "effectiveDate": { "type": "string", "description": "The date from which the current license data is valid.\nA license can change during its validity period.", "format": "date-time", "nullable": true }, "licensees": { "type": "array", "items": { "$ref": "#/components/schemas/AnalysisLicenseeForAggregationDto" }, "description": "The licensees of this license." }, "crsId": { "type": "integer", "description": "Coordinate reference system unique identifier (EPSG number, like: 4326).", "format": "int32", "nullable": true }, "innerRings": { "type": "array", "items": { "type": "string" }, "description": "The list of holes in the polygon representation of this license (optional)." }, "wktPolygon": { "type": "string", "description": "Store the license geometry in wkt polygon.", "deprecated": true }, "outerRing": { "type": "string", "description": "The outer ring of the polygon. If there is a polygon data, this has to be filled." }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryWithRealNameDto" }, "description": "The change history" }, "folderDetails": { "$ref": "#/components/schemas/AggregatedFolderParentsDto" }, "areProspectsUpToDate": { "type": "boolean", "description": "True if there are no prospects associated with older versions of this license." }, "prospects": { "type": "array", "items": { "$ref": "#/components/schemas/ProspectAnalysisDataForLicenseDto" }, "description": "Aggregated prospect of the segment/dry/discovery analysis which has this license." }, "blockNames": { "type": "array", "items": { "type": "string" }, "description": "Contains the distinct list of block names associated with this license." }, "nationName": { "type": "string", "description": "The name of the nation to which this license belongs." }, "nationId": { "type": "integer", "description": "The unique identifier of the nation to which this license belongs.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing aggregated license data (block, nation, licensees)." }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": {} }, "ProspectAnalysisAggregationDataWithResultDto": { "type": "object", "properties": { "successDiscovery": { "type": "number", "description": "The likelihood of finding hydrocarbons.", "format": "double", "nullable": true }, "aboveScreeningThreshold": { "type": "number", "description": "The likelihood of finding greater volumes of hydrocarbons than a threshold value.", "format": "double", "nullable": true }, "wellPath": { "type": "number", "description": "The likelihood of finding hydrocarbons when drilling along this well path.", "format": "double", "nullable": true }, "results": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AnalysisAggregationResultDataDto" }, "description": "The aggregated analysis result parameters, organized by result parameter name." }, "oilOnly": { "type": "number", "description": "The probability that the prospect contains hydrocarbon, but oil only (i.e. no gas).", "format": "double", "nullable": true }, "gasOnly": { "type": "number", "description": "The probability that the prospect contains hydrocarbon, but gas only (i.e. no oil).", "format": "double", "nullable": true }, "oilAndGas": { "type": "number", "description": "The probability that the prospect contains hydrocarbon, both oil and gas.", "format": "double", "nullable": true }, "dfiRiskSummaries": { "type": "array", "items": { "$ref": "#/components/schemas/DirectFluidIndicatorRiskSummaryDto" }, "description": "A collection of Direct Fluid Indicator (DFI) risk summaries." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing prospect analysis aggregation." }, "ProspectAnalysisAggregationDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the analysis aggregation.", "format": "int32" }, "name": { "type": "string", "description": "The name of the analysis aggregation." }, "modifiedDate": { "type": "string", "description": "The date the analysis aggregation was last modified.", "format": "date-time" }, "modifiedUserName": { "type": "string", "description": "The user name of the person who last modified the analysis aggregation." }, "modifiedRealName": { "type": "string", "description": "The real name of the user who most recently modified the analysis aggregation." }, "createdDate": { "type": "string", "description": "The date the analysis aggregation was created.", "format": "date-time" }, "createdUserName": { "type": "string", "description": "The user name of the person creating the analysis aggregation." }, "createdRealName": { "type": "string", "description": "The real name of the user who created the analysis aggregation." }, "prospectId": { "type": "integer", "description": "The prospect folder ID.", "format": "int32" }, "prospectName": { "type": "string", "description": "The prospect name." }, "version": { "type": "string", "description": "The version of the prospect analysis aggregation.\nPermitted values are approved (A), historic (H), working (W) and test (T)." }, "useHcPhaseRisking": { "type": "boolean", "description": "True if at least one enrolled analysis uses hydrocarbon phase risking." }, "input": { "$ref": "#/components/schemas/AnalysisAggregationInputDto" }, "analysisResult": { "$ref": "#/components/schemas/ProspectAnalysisAggregationDataWithResultDto" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AggregatedAnalysisPropertyDto" }, "description": "The properties of the prospect analysis aggregation." }, "folderDetails": { "$ref": "#/components/schemas/AggregatedFolderParentsDto" }, "crsId": { "type": "integer", "description": "The coordinate reference system ID (EPSG number, like: 4326).", "format": "int32", "nullable": true }, "innerRings": { "type": "array", "items": { "type": "string" }, "description": "The list of holes in the polygon representing this prospect (optional)." }, "outerRing": { "type": "string", "description": "The outer ring of the polygon representing this prospect.\nIf there is a polygon data, this has to be filled." }, "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/EnrolledSegmentAnalysisEntitlementDto" }, "description": "The entitlements of the enrolled analyses." }, "risks": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/EnrolledAnalysisExtendedRiskDto" } }, "description": "The risks of the enrolled analyses." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing prospect analysis aggregation." }, "ProspectAnalysisDataForLicenseDto": { "type": "object", "properties": { "analysisId": { "type": "integer", "description": "Prospect analysis id", "format": "int32" }, "analysisName": { "type": "string", "description": "Prospect analysis name" }, "parentId": { "type": "integer", "description": "Parent prospect id", "format": "int32" }, "parentName": { "type": "string", "description": "Parent prospect name" }, "version": { "type": "string", "description": "Analysis version (working/approved)" }, "successDiscovery": { "type": "number", "description": "Likelihood of finding hydrocarbons", "format": "double", "nullable": true }, "aboveScreeningThreshold": { "type": "number", "description": "Likelihood of finding greater volumes of hydrocarbons than a threshold value", "format": "double", "nullable": true }, "wellPath": { "type": "number", "description": "The well path", "format": "double", "nullable": true }, "hcPhase": { "type": "string", "description": "Hydrocarbon phase of the prospect analysis" }, "results": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "description": "Analysis result mean values (Result type - mean value)" } }, "additionalProperties": false, "description": "Contains prospect analysis result mean values" }, "ProspectAnalysisDetailsAggregationDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier of the prospect analysis.", "format": "int32" }, "summary": { "type": "string", "description": "The prospect analysis summary." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentAnalysisAggregationDto" }, "description": "The collection of segment analysis aggregations." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing an aggregation of prospect analysis details." }, "ProspectMultipleScenarioAnalysisAggregationDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the analysis aggregation.", "format": "int32" }, "name": { "type": "string", "description": "The name of the analysis aggregation." }, "modifiedDate": { "type": "string", "description": "The date the analysis aggregation was last modified.", "format": "date-time" }, "modifiedUserName": { "type": "string", "description": "The user name of the person who last modified the analysis aggregation." }, "modifiedRealName": { "type": "string", "description": "The real name of the user who most recently modified the analysis aggregation." }, "createdDate": { "type": "string", "description": "The date the analysis aggregation was created.", "format": "date-time" }, "createdUserName": { "type": "string", "description": "The user name of the person creating the analysis aggregation." }, "createdRealName": { "type": "string", "description": "The real name of the user who created the analysis aggregation." }, "prospectId": { "type": "integer", "description": "The prospect folder ID.", "format": "int32" }, "prospectName": { "type": "string", "description": "The prospect name." }, "version": { "type": "string", "description": "The version of the prospect multiple scenario analysis aggregation.\nAllowed values are A (approved), H (historical), W (working) and T (test)." }, "summary": { "type": "string", "description": "The summary of the prospect multiple scenario analysis aggregation." }, "analysisResult": { "$ref": "#/components/schemas/ProspectAnalysisAggregationDataWithResultDto" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AnalysisPropertyDto" }, "description": "The properties of the prospect multiple scenario aggregation." }, "scenarioSetups": { "type": "array", "items": { "$ref": "#/components/schemas/ScenarioSetupDto" }, "description": "The analysis scenario setups used in this prospect multiple scenario aggregation." }, "overallUnconditionalProspect": { "type": "number", "description": "The sum of the scenario's multiplication of ProbabilityRecoverableSuccess and MeanRecoverableSuccess.", "format": "double" }, "nonSuccessProbability": { "type": "number", "description": "The value of Non Success Probability.", "format": "double" }, "crsId": { "type": "integer", "description": "Coordinate reference system ID (EPSG number, like: 4326).", "format": "int32", "nullable": true }, "innerRings": { "type": "array", "items": { "type": "string" }, "description": "The list of holes (optional)" }, "outerRing": { "type": "string", "description": "The outer ring of the polygon. If there is a polygon data, this has to be filled." }, "prospectAnalysisProperties": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AnalysisPropertyDto" } }, "description": "List of enrolled, prospect analysis properties. One multiple scenario analysis can have multiple, enrolled prospect analysis" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a prospect multiple scenario analysis aggregation." }, "ResourceLimitsForAggregationDto": { "type": "object", "properties": { "useScreeningThreshold": { "type": "boolean", "description": "Indicate if the above screening threshold resource limit was set." }, "hcType": { "type": "string", "description": "The hydrocarbon type list [Oil, NonAssoc.Gas, Assoc.Gas, Condensate, or Total Resources] defines\nthe fluid basis for defining a success case's minimum recoverable volume." }, "volume": { "type": "number", "description": "Defines a minimum economic recoverable volume.\nThe screening threshold estimates a probability for a discovery above the screening threshold.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing resource limits for aggregation." }, "ScenarioSetupDto": { "type": "object", "properties": { "analysisId": { "type": "integer", "description": "Analysis ID in this scenario", "format": "int32" }, "analysisName": { "maxLength": 256, "type": "string", "description": "Analysis name" }, "analysisType": { "type": "string", "description": "Analysis type" }, "weight": { "type": "number", "description": "The relative weight of this scenario", "format": "double" }, "meanRecoverableSuccess": { "type": "number", "description": "The mean of the recoverable success details", "format": "double" }, "probabilityRecoverableSuccess": { "type": "number", "description": "The probability of the recoverable success details", "format": "double" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing an analysis scenario setup.\nThe setup contains analysis ID, name and its weight in the scenario." }, "SegmentAnalysisAggregationDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the segment.", "format": "int32" }, "name": { "type": "string", "description": "The name of the segment." }, "folderDetails": { "$ref": "#/components/schemas/AggregatedFolderParentsDto" }, "summary": { "type": "string", "description": "The segment analysis summary." }, "entitlements": { "type": "array", "items": { "$ref": "#/components/schemas/EnrolledSegmentAnalysisEntitlementDto" }, "description": "The entitlements of the enrolled segment analyses." }, "analysisResult": { "$ref": "#/components/schemas/AnalysisAggregationDataWithResultDto" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AnalysisPropertyDto" }, "description": "The properties of the aggregated analysis." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing segment and enrolled analysis aggregation data." } }, "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "User Token from SLB Authenticator Service" }, "appkey": { "type": "apiKey", "description": "AppKey/ConsumerKey from your App on Developer Portal", "name": "appkey", "in": "header" } } }, "security": [ { "bearer": [], "appkey": [] } ], "tags": [ { "name": "LicenseAggregation", "description": "License aggregation management." }, { "name": "ProspectAnalysisAggregation", "description": "Prospect analysis aggregation management." }, { "name": "FullCycleAnalysisAggregation", "description": "Full cycle analysis aggregation management." }, { "name": "ProspectMultipleScenarioAnalysisAggregation", "description": "Prospect multiple scenario analysis aggregation management." } ] }