The endpoints query the Geox and Opportunity Assessor database for the organizational objects representing the geological entities basin, play and segment as well as the prospect. Basins, plays, prospects, and segments are arranged in a folder hierarchy. Each folder can contain other folders.
If you know the name of the prospect analysis you are looking for, or the prospect folder name, you can search for the analysis using the search endpoint and find the prospect analysis ID that way.
Alternatively, start with the /basins endpoint to find all root basins you have access to in your database. In the response you will find IDs of each root basin's children, i.e. sub-basins, plays, and prospects.
\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/basins": { "get": { "tags": [ "Basins" ], "summary": "Get all root-level basin folders.", "description": "Gets all root-level basin folders that the user has access to in the GeoX and Opportunity Assessor database.\nOnly root-level objects are returned; no children are returned, even when they exist.", "operationId": "GetAllRootBasins", "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" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BasinDto" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BasinDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BasinDto" } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/assessments/v1/basins/{id}": { "get": { "tags": [ "Basins" ], "summary": "Get a basin and its child basins, plays, prospects and segments", "description": "Returns the basin with the supplied ID along with IDs of its child folders and associated analyses.\nChild objects are returned one level down only.\nNo grandchildren are returned, even when they exist.", "operationId": "GetBasin", "parameters": [ { "name": "id", "in": "path", "description": "Basin 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/BasinDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BasinDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BasinDto" } } } }, "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/plays/{id}": { "get": { "tags": [ "Plays" ], "summary": "Get a play and its child plays, segments and prospects", "description": "Returns the play with the supplied ID along with IDs of its child folders and associated analyses.\nChild objects are returned one level down only.\nNo grandchildren are returned, even when they exist.", "operationId": "GetPlay", "parameters": [ { "name": "id", "in": "path", "description": "Play 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/PlayDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlayDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlayDto" } } } }, "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/prospects/{id}": { "get": { "tags": [ "Prospects" ], "summary": "Get prospect by ID", "description": "Returns the prospect with the supplied ID along with IDs of its associated analyses.", "operationId": "GetProspect", "parameters": [ { "name": "id", "in": "path", "description": "Prospect 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/ProspectDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProspectDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProspectDto" } } } }, "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/segments/{id}": { "get": { "tags": [ "Segments" ], "summary": "Get segment by ID", "description": "Returns the segment with the supplied ID along with IDs of its associated analyses.", "operationId": "GetSegment", "parameters": [ { "name": "id", "in": "path", "description": "Segment 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/SegmentDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SegmentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SegmentDto" } } } }, "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/prospectanalysis": { "get": { "tags": [ "ProspectAnalysis" ], "summary": "Search for prospect analysis by name", "description": "Returns a list of prospect analyses that fit the search criteria. The results are paginated.", "operationId": "GetProspectAnalysisByName", "parameters": [ { "name": "AnalysisName", "in": "query", "description": "Prospect analysis name", "schema": { "type": "string" } }, { "name": "ProspectName", "in": "query", "description": "Prospect folder name", "schema": { "type": "string" } }, { "name": "Offset", "in": "query", "description": "How many analyses to skip in the result, default is 0", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Limit", "in": "query", "description": "Maximum number of analyses to return, default is 200, maximum is 2000", "schema": { "type": "integer", "format": "int32", "default": 200 } }, { "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/ProspectAnalysisSearchResultDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProspectAnalysisSearchResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProspectAnalysisSearchResultDto" } } } }, "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/prospectanalysis/{id}": { "get": { "tags": [ "ProspectAnalysis" ], "summary": "Get prospect analysis data (results, properties, inputs, metadata) by ID", "description": "Returns the prospect analysis with the supplied ID along with its metadata, properties, inputs and results.", "operationId": "GetProspectAnalysisData", "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/ProspectAnalysisDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProspectAnalysisDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProspectAnalysisDto" } } } }, "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" } } } } }, "components": { "schemas": { "AnalysisPropertyTypeDto": { "enum": [ "Text", "Date", "Integer", "Float" ], "type": "string", "description": "A data transfer object (DTO) representing analysis property types." }, "AnalysisStatusDto": { "enum": [ "Approved", "Historical", "Test", "Working" ], "type": "string", "description": "Analysis status" }, "BasinDto": { "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)." }, "hasPolygon": { "type": "boolean", "description": "Indicates whether the folder has a related polygon." }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/FolderDto" }, "description": "Child folders." }, "analysis": { "type": "array", "items": { "$ref": "#/components/schemas/FolderAnalysisDto" }, "description": "Analyses associated with this folder." }, "parentFolderId": { "type": "integer", "description": "ID of the parent folder.\n0 if the parent folder is a root-level basin.", "format": "int32" }, "type": { "type": "string", "description": "The type of geological structure object, in this case a basin.", "readOnly": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a basin, i.e. a depression in the crust of the Earth,\ncaused by plate tectonic activity and subsidence, in which sediments accumulate.\nA basin in GeoX and Opportunity Assessor can contain zero or more basins, plays, segments and prospects." }, "CalculationMethodDto": { "enum": [ "Stochastic", "Deterministic" ], "type": "string", "description": "Calculation method: probabilistic or deterministic." }, "CalculationResultDto": { "type": "object", "properties": { "results": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DistributionDetailsDto" }, "description": "The calculation results, listed by parameter name." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing prospect calculation results." }, "CalculationSettingsDto": { "type": "object", "properties": { "calculationMethod": { "$ref": "#/components/schemas/CalculationMethodDto" }, "initialSeed": { "type": "integer", "description": "The initial seed for the random number generator.\nRunning a second calculation with the same initial seed causes the calculator to select the same numbers again.", "format": "int32", "nullable": true }, "sampleSize": { "type": "integer", "description": "How many trials to compute.", "format": "int32" }, "useInitialSeed": { "type": "boolean", "description": "Controls the use of the initial seed value." }, "resourceLimits": { "$ref": "#/components/schemas/ResourceLimitsDto" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing the Monte Carlo simulation settings." }, "DependencyGroupDto": { "type": "object", "properties": { "name": { "maxLength": 256, "type": "string", "description": "The name of the dependency group, chosen by the user." }, "parameterName": { "maxLength": 64, "type": "string", "description": "The name of the risk parameter (risk factor) displaying a dependency." }, "probability": { "type": "number", "description": "The shared probability of the risk dependency.\nValue must be in the range [0, 1].\n0 means maximum shared probability.\nNull when max correlation is used (Slb.Spar.WebApi.DTOs.v1.Analysis.ProspectAnalysis.DependencyGroupDto.IsMaxCorrelation is true).", "format": "double", "nullable": true }, "isMaxCorrelation": { "type": "boolean", "description": "Determines the type of dependency - Max correlation (true) or Shared probability (false)." }, "isForPlayRiskDependency": { "type": "boolean", "description": "Determines the source of dependency - play risk dependency (true) or conditional (i.e. segment) risk dependency (false)." }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/DependencyGroupMemberDto" }, "description": "The members of the dependency group (representing risk factors)." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a risk/volume dependency group.\nRisk factors in different segments can depend on each other.\nSome types of risk factors can, when dependent, also cause a volume dependency between segments.\nThese dependencies are modeled in GeoX and Opportunity Assessor as a dependency group." }, "DependencyGroupMemberDto": { "type": "object", "properties": { "name": { "maxLength": 256, "type": "string", "description": "The name of the parent segment of the enrolled analysis,\nthe name of the play if this object is a member of a play dependency group,\nor the name of the parent dependency group if this member is itself representing a group." }, "parameterName": { "maxLength": 64, "type": "string", "description": "The risk parameter name." }, "isForPlayRiskDependency": { "type": "boolean", "description": "Determines the source of dependency - play risk dependency (true) or conditional (i.e. segment) risk dependency (false)." }, "isGroup": { "type": "boolean", "description": "Indicates whether this member is itself a group; if true, there must be a DependencyGroup with the same name." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a member of a dependency group.\nDependency group members are risk factors." }, "DistributionDetailsDto": { "type": "object", "properties": { "mean": { "type": "number", "description": "The mean (average).", "format": "double" }, "mode": { "type": "number", "description": "The most likely value.", "format": "double", "nullable": true }, "name": { "maxLength": 128, "type": "string", "description": "The name of the parameter." }, "n": { "type": "integer", "description": "The number of samples.", "format": "int32", "nullable": true }, "binWidth": { "type": "number", "description": "The distance between bins.", "format": "double", "nullable": true }, "standardDeviation": { "type": "number", "description": "The standard deviation.", "format": "double" }, "p": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "description": "The probability that a randomly drawn value is greater than or equal to the central value of each bin.\nMonotonically falling from 1 to 0." }, "bins": { "type": "array", "items": { "type": "number", "format": "double" }, "description": "The bin central values. Also the bin count." }, "binsProbability": { "type": "array", "items": { "type": "number", "format": "double" }, "description": "The probability that a randomly drawn value falls into each bin." } }, "additionalProperties": false, "description": "A data transfer object (DTO) to identify and visualize a distribution of random values." }, "FolderAnalysisDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique analysis ID.", "format": "int32" }, "name": { "maxLength": 256, "type": "string", "description": "The analysis name." }, "type": { "maxLength": 16, "type": "string", "description": "The analysis type (prospect, segment, play)." }, "modifiedDate": { "type": "string", "description": "The date and time the analysis was last modified.", "format": "date-time", "nullable": true }, "modifiedUserName": { "maxLength": 64, "type": "string", "description": "The user name of the person last modifying the analysis.", "nullable": true }, "modifiedRealName": { "maxLength": 64, "type": "string", "description": "The real name of the person last modifying the analysis.", "nullable": true }, "version": { "maxLength": 1, "type": "string", "description": "The version of the analysis." }, "isExternal": { "type": "boolean", "description": "Is external flag.", "nullable": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a folder (prospect, segment, play) analysis.\nAn analysis in GeoX and Opportunity Assessor is an assessment of the hydrocarbon volume and risks associated with\nthe geological structure corresponding to the folder in which the analysis resides." }, "FolderDto": { "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)." }, "type": { "type": "string", "description": "The type of geological structure object, i.e. basin, play, segment or prospect.", "readOnly": true }, "hasPolygon": { "type": "boolean", "description": "Indicates whether the folder has a related polygon." }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/FolderDto" }, "description": "Child folders." }, "analysis": { "type": "array", "items": { "$ref": "#/components/schemas/FolderAnalysisDto" }, "description": "Analyses associated with this folder." }, "parentFolderId": { "type": "integer", "description": "ID of the parent folder.\n0 if the parent folder is a root-level basin.", "format": "int32" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a geological structure, i.e. basin, play, segment or prospect.\nGeological structures in GeoX and Opportunity Assessor are commonly known and organized as folders." }, "FolderInfoDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the folder (basin, play or prospect)." }, "id": { "type": "integer", "description": "The unique identifier.", "format": "int32" }, "parentId": { "type": "integer", "description": "ID of the parent folder. null value if the parent folder is a root-level basin.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a geological structure, i.e. basin, play or prospect, used in searches.\nGeological structures in GeoX and Opportunity Assessor are commonly known and organized as folders." }, "HcTypeDto": { "enum": [ "Oil", "NonAssociatedGas", "AssociatedGas", "Condensate", "OilEquivalent" ], "type": "string", "description": "Hydrocarbon case type for resource limits." }, "PaginationDto": { "type": "object", "properties": { "next": { "type": "string", "description": "The relative URL for the next result page.", "nullable": true }, "self": { "type": "string", "description": "The relative URL for this result page." } }, "additionalProperties": false, "description": "Result pagination" }, "PlayDto": { "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)." }, "hasPolygon": { "type": "boolean", "description": "Indicates whether the folder has a related polygon." }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/FolderDto" }, "description": "Child folders." }, "analysis": { "type": "array", "items": { "$ref": "#/components/schemas/FolderAnalysisDto" }, "description": "Analyses associated with this folder." }, "parentFolderId": { "type": "integer", "description": "ID of the parent folder.\n0 if the parent folder is a root-level basin.", "format": "int32" }, "type": { "type": "string", "description": "The type of geological structure object, in this case a play.", "readOnly": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a play, i.e. a geological area in which hydrocarbon accumulations or prospects of a given type occur.\nA play in GeoX and Opportunity Assessor can contain zero or more plays, segments and prospects." }, "PlayRiskDependencyGroupDto": { "type": "object", "properties": { "name": { "maxLength": 256, "type": "string", "description": "Label for the dependency group." }, "isMaxCorrelation": { "type": "boolean", "description": "Determines the type of dependency - Max correlation (true) or Shared probability (false)." }, "sharedProbability": { "type": "number", "description": "Shared probability for risk dependency, lower value indicates higher dependency. Null when max correlation is used.", "format": "double", "nullable": true }, "riskTypeId": { "type": "integer", "description": "ID of the risk type identified for this group.", "format": "int32" }, "description": { "maxLength": 2000, "type": "string", "description": "Dependency group description.", "nullable": true }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/PlayRiskDependencyGroupMemberDto" }, "description": "Plays that make up this dependency group." }, "memberGroups": { "type": "array", "items": { "$ref": "#/components/schemas/PlayRiskDependencyGroupDto" }, "description": "Play risk dependency groups can be members of other play risk dependency groups." } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a play risk dependency group.\nLike Slb.Spar.WebApi.DTOs.v1.Analysis.ProspectAnalysis.DependencyGroupDto, only for risk factors associated with plays." }, "PlayRiskDependencyGroupMemberDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the play that is a play risk dependency group member.", "format": "int32" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a play as member of a play risk dependency group." }, "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": {} }, "PropertyDto": { "type": "object", "properties": { "propertyModelId": { "type": "integer", "description": "ID of the property model that this property belongs to.", "format": "int32" }, "label": { "maxLength": 64, "type": "string", "description": "Property label." }, "identifier": { "maxLength": 64, "type": "string", "description": "Unique identifier of the property." }, "textValue": { "maxLength": 2000, "type": "string", "description": "Property value when Slb.Spar.WebApi.DTOs.v1.GeoNext.PropertyDto.Type is Text.", "nullable": true }, "integerValue": { "type": "integer", "description": "Property value when Slb.Spar.WebApi.DTOs.v1.GeoNext.PropertyDto.Type is Integer.", "format": "int32", "nullable": true }, "floatValue": { "type": "number", "description": "Property value when Slb.Spar.WebApi.DTOs.v1.GeoNext.PropertyDto.Type is Float.", "format": "double", "nullable": true }, "dateValue": { "type": "string", "description": "Property value when Slb.Spar.WebApi.DTOs.v1.GeoNext.PropertyDto.Type is Date.", "format": "date-time", "nullable": true }, "type": { "$ref": "#/components/schemas/AnalysisPropertyTypeDto" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing an analysis descriptive property." }, "ProspectAnalysisDataCorrelationParameterDto": { "required": [ "correlationFactor", "dependentParameter", "independentParameter" ], "type": "object", "properties": { "correlationFactor": { "type": "number", "description": "The strength of the correlation.", "format": "double" }, "dependentParameter": { "maxLength": 256, "minLength": 1, "type": "string", "description": "The name of the dependent parameter." }, "independentParameter": { "maxLength": 256, "minLength": 1, "type": "string", "description": "The name of the independent parameter." }, "dependentSegmentId": { "type": "integer", "description": "The id of the segment which the dependent parameter belongs to.", "format": "int32", "nullable": true }, "independentSegmentId": { "type": "integer", "description": "The id of the segment which the independent parameter belongs to.", "format": "int32", "nullable": true }, "dependentSegmentName": { "maxLength": 256, "type": "string", "description": "The name of the segment which the dependent parameter belongs to.", "nullable": true }, "independentSegmentName": { "maxLength": 256, "type": "string", "description": "The name of the segment which the independent parameter belongs to.", "nullable": true }, "dependentAnalysisId": { "type": "integer", "description": "The id of the analysis which the dependent parameter belongs to.", "format": "int32", "nullable": true }, "independentAnalysisId": { "type": "integer", "description": "The id of the analysis which the independent parameter belongs to.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a prospect analysis correlation parameter.\nUnder certain conditions parameters in one (dependent) segment can be correlated with\nthe corresponding parameters in another (independent) segment." }, "ProspectAnalysisDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "Analysis ID.", "format": "int32" }, "name": { "maxLength": 256, "type": "string", "description": "Analysis name." }, "summary": { "type": "string", "description": "Analysis summary." }, "parentId": { "type": "integer", "description": "Analysis parent ID.", "format": "int32" }, "parentName": { "maxLength": 256, "type": "string", "description": "Analysis parent name." }, "modifiedDate": { "type": "string", "description": "Date and time the analysis was last modified.", "format": "date-time" }, "modifiedUserName": { "maxLength": 64, "type": "string", "description": "User name of the person who last modified the analysis." }, "status": { "$ref": "#/components/schemas/AnalysisStatusDto" }, "results": { "$ref": "#/components/schemas/ProspectRiskAndCalculationResultDto" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Analysis descriptive properties." }, "inputs": { "$ref": "#/components/schemas/ProspectAnalysisInputDto" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a prospect analysis." }, "ProspectAnalysisInfoDto": { "type": "object", "properties": { "analysisName": { "type": "string", "description": "The prospect analysis name." }, "analysisId": { "type": "integer", "description": "The prospect analysis unique identifier.", "format": "int32" }, "analysisPath": { "type": "string", "description": "The path to the prospect analysis from the root basin.\nExample: basin1/basin2/play1/play2/play3/prospect.\nNote there is a limitation on 5 levels of basins and 5 levels of plays.\nIf the path contains more than 5 levels of basins and/or more than 5 levels of plays, it will be incorrect." }, "prospect": { "$ref": "#/components/schemas/FolderInfoDto" }, "plays": { "type": "array", "items": { "$ref": "#/components/schemas/FolderInfoDto" }, "description": "The play folders contained in the path to the prospect analysis." }, "basins": { "type": "array", "items": { "$ref": "#/components/schemas/FolderInfoDto" }, "description": "The basin folders contained in the path to the prospect analysis." }, "createdDate": { "type": "string", "description": "The date and time the prospect analysis was created.", "format": "date-time" }, "createdBy": { "type": "string", "description": "The user name of the person who created the prospect analysis." }, "createdByRealName": { "type": "string", "description": "The real name of the person who created the prospect analysis. May be null." }, "lastModifiedDate": { "type": "string", "description": "The date and time the prospect analysis was last modified.", "format": "date-time" }, "lastModifiedBy": { "type": "string", "description": "The user name of the person who last modified the prospect analysis." }, "lastModifiedByRealName": { "type": "string", "description": "The real name of the person who last modified the prospect analysis. May be null." }, "status": { "$ref": "#/components/schemas/AnalysisStatusDto" }, "isExternal": { "type": "boolean", "description": "Whether or not the prospect analysis is external.", "nullable": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a prospect analysis in search result." }, "ProspectAnalysisInputDto": { "type": "object", "properties": { "calculationSettings": { "$ref": "#/components/schemas/CalculationSettingsDto" }, "enrolledAnalysisIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Enrolled segment analysis IDs" }, "dbCompatiblePlayRiskDependencyGroups": { "type": "array", "items": { "$ref": "#/components/schemas/PlayRiskDependencyGroupDto" }, "description": "Play risk dependency groups" }, "conditionalRiskDependencyGroups": { "type": "array", "items": { "$ref": "#/components/schemas/DependencyGroupDto" }, "description": "Conditional (segment) risk dependency groups" }, "resourceLimits": { "$ref": "#/components/schemas/ResourceLimitsForAggregationDto" }, "correlations": { "type": "array", "items": { "$ref": "#/components/schemas/ProspectAnalysisDataCorrelationParameterDto" }, "description": "Parameters whose values are correlated between segments" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing prospect analysis input data." }, "ProspectAnalysisSearchResultDto": { "type": "object", "properties": { "analyses": { "type": "array", "items": { "$ref": "#/components/schemas/ProspectAnalysisInfoDto" }, "description": "The prospect analyses contained in the search result." }, "pagination": { "$ref": "#/components/schemas/PaginationDto" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a prospect analysis search result." }, "ProspectDto": { "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)." }, "hasPolygon": { "type": "boolean", "description": "Indicates whether the folder has a related polygon." }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/FolderDto" }, "description": "Child folders." }, "analysis": { "type": "array", "items": { "$ref": "#/components/schemas/FolderAnalysisDto" }, "description": "Analyses associated with this folder." }, "parentFolderId": { "type": "integer", "description": "ID of the parent folder.\n0 if the parent folder is a root-level basin.", "format": "int32" }, "type": { "type": "string", "description": "The type of geological structure object, in this case a prospect.", "readOnly": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a potential hydrocarbon accumulation, known as prospect.\nProspects consist of one or more segments.\nA prospect folder in GeoX and Opportunity Assessor can contain zero or more prospect analyses." }, "ProspectRiskAndCalculationResultDto": { "type": "object", "properties": { "risks": { "$ref": "#/components/schemas/ProspectRiskResultDto" }, "distributions": { "$ref": "#/components/schemas/CalculationResultDto" } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing the risk and calculation result for a prospect analysis." }, "ProspectRiskResultDto": { "type": "object", "properties": { "chanceOfSuccess": { "type": "number", "description": "Probability of successful discovery.", "format": "double", "nullable": true }, "aboveScreeningThreshold": { "type": "number", "description": "The probability that the hydrocarbon volume in the prospect is greater than the screening threshold.\nThe screening threshold is a volume limit set by the user, usually a financial limit.", "format": "double", "nullable": true }, "oilOnly": { "type": "number", "description": "The probability that the hydrocarbons in the prospect are oil phase only.", "format": "double", "nullable": true }, "gasOnly": { "type": "number", "description": "The probability that the hydrocarbons in the prospect are gas phase only.", "format": "double", "nullable": true }, "oilAndGas": { "type": "number", "description": "The probability that the hydrocarbons in the prospect are a combination of oil and gas phase.", "format": "double", "nullable": true }, "oil": { "type": "number", "description": "The probability that the hydrocarbons in the prospect contain oil phase.", "format": "double", "nullable": true }, "gas": { "type": "number", "description": "The probability that the hydrocarbons in the prospect contain gas phase.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing the risk results of a prospect analysis." }, "ResourceLimitsDto": { "type": "object", "properties": { "minimumVolumeHcType": { "$ref": "#/components/schemas/HcTypeDto" }, "minimumVolume": { "type": "number", "description": "Minimum volume", "format": "double", "nullable": true }, "screeningThresholdHcType": { "$ref": "#/components/schemas/HcTypeDto" }, "screeningThresholdVolume": { "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 }, "wellPathDepth": { "type": "number", "description": "Depth of the well path", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Resource limits" }, "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." }, "SegmentDto": { "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)." }, "hasPolygon": { "type": "boolean", "description": "Indicates whether the folder has a related polygon." }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/FolderDto" }, "description": "Child folders." }, "analysis": { "type": "array", "items": { "$ref": "#/components/schemas/FolderAnalysisDto" }, "description": "Analyses associated with this folder." }, "parentFolderId": { "type": "integer", "description": "ID of the parent folder.\n0 if the parent folder is a root-level basin.", "format": "int32" }, "type": { "type": "string", "description": "The type of geological structure object, in this case a segment.", "readOnly": true } }, "additionalProperties": false, "description": "A data transfer object (DTO) representing a segment, which is the smallest assessable geological structure in GeoX and Opportunity Assessor.\nA segment is in other systems referred to as a tank, a target, a compartment or a zone.\nOne or more segments can be included in a prospect.\nA segment folder in GeoX and Opportunity Assessor can contain zero or more segment analyses." } }, "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": "Basins", "description": "Basin folder management." }, { "name": "Plays", "description": "Play folder management." }, { "name": "Prospects", "description": "Prospect folder management." }, { "name": "Segments", "description": "Segment folder management." }, { "name": "ProspectAnalysis", "description": "Prospect analysis management." } ] }