| `LOCAL` | `FIXED/OPEN` | |
| `Viewer` | data.referencedata-local.viewers | data.referencedata.viewers |
| `Owner` | data.referencedata-local.owners | data.referencedata.owners |
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```"}},{"type":"group","fsPath":"solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis.json","link":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis","label":"Reporting by unit and analysis","items":[{"type":"group","label":"LicenseAggregation","link":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/licenseaggregation","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/licenseaggregation","items":[{"label":"Get license aggregation data for all versions by license ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/licenseaggregation/publicgetalllicenseaggregationversions","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/licenseaggregation/publicgetalllicenseaggregationversions","metadata":{"seo":{"title":"Get license aggregation data for all versions by license ID","description":"Returns the license aggregation data for all versions by license ID. This includes block(s), nation, licensees and lists all prospects linked to the license: Each prospect listed includes information about geological risk together with their gross and net resources in the license."}},"httpPath":"/assessments/v1/licenseaggregation/{id}"}]},{"type":"group","label":"ProspectAnalysisAggregation","link":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/prospectanalysisaggregation","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/prospectanalysisaggregation","items":[{"label":"Get prospect analysis aggregate report by prospect analysis ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/prospectanalysisaggregation/publicgetprospectanalysisaggregationbyprospectanalysisid","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/prospectanalysisaggregation/publicgetprospectanalysisaggregationbyprospectanalysisid","metadata":{"seo":{"title":"Get prospect analysis aggregate report by prospect analysis ID","description":"Gets prospect analysis aggregate report by prospect analysis ID. The report contains chance of success and resource volumes for the prospect analysis, the enrolled segment level risks and resource volumes, as well as information about associated folders, polygon, and entitlement (block/license)."}},"httpPath":"/assessments/v1/prospectanalysisaggregation/{id}"},{"label":"Get segment analysis enrolled in prospect analysis by prospect analysis ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/prospectanalysisaggregation/getprospectanalysisdetailsfordeveloperportalbyprospectanalysisid","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/prospectanalysisaggregation/getprospectanalysisdetailsfordeveloperportalbyprospectanalysisid","metadata":{"seo":{"title":"Get segment analysis enrolled in prospect analysis by prospect analysis ID","description":"Gets segment analysis enrolled in prospect analysis by prospect analysis ID. This returns enrolled segment analysis name, properties, chance of success, resource volumes and entitlement (block/license) information linked to these segments."}},"httpPath":"/assessments/v1/prospectanalysisaggregation/{id}/details"}]},{"type":"group","label":"FullCycleAnalysisAggregation","link":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/fullcycleanalysisaggregation","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/fullcycleanalysisaggregation","items":[{"label":"Get aggregated results for all full cycle analyses associated with a prospect analysis by its ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/fullcycleanalysisaggregation/getfullcycleanalysisaggregationbyprospectanalysisidfordeveloperportal","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/fullcycleanalysisaggregation/getfullcycleanalysisaggregationbyprospectanalysisidfordeveloperportal","metadata":{"seo":{"title":"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 indicators on each of the project, contractor and working interest level for all full cycle analyses associated with a prospect analysis by parent prospect analysis ID."}},"httpPath":"/assessments/v1/fullcycleanalysisaggregation"}]},{"type":"group","label":"ProspectMultipleScenarioAnalysisAggregation","link":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/prospectmultiplescenarioanalysisaggregation","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/prospectmultiplescenarioanalysisaggregation","items":[{"label":"Get prospect multiple scenario analysis set-up and results by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/prospectmultiplescenarioanalysisaggregation/getprospectmultiplescenarioanalysisaggregationbyanalysisfordeveloperportalid","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-unit-and-analysis/prospectmultiplescenarioanalysisaggregation/getprospectmultiplescenarioanalysisaggregationbyanalysisfordeveloperportalid","metadata":{"seo":{"title":"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 polygon by prospect multiple scenario analysis ID."}},"httpPath":"/assessments/v1/prospectmultiplescenarioanalysisaggregation/{id}"}]}],"metadata":{"type":"openapi","title":"Reporting by unit and analysis","version":"1","description":"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```"}},{"type":"group","fsPath":"solutions/opportunity-assessor/apis/reporting-by-portfolio.json","link":"/solutions/opportunity-assessor/apis/reporting-by-portfolio","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-portfolio","label":"Reporting by portfolio","items":[{"type":"group","label":"Reporting","link":"/solutions/opportunity-assessor/apis/reporting-by-portfolio/reporting","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-portfolio/reporting","items":[{"label":"Returns all active public custom views","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/opportunity-assessor/apis/reporting-by-portfolio/reporting/getcustomviewswithvisibility","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-portfolio/reporting/getcustomviewswithvisibility","metadata":{"seo":{"title":"Returns all active public custom views","description":"Returns names, IDs and descriptions of all active public custom views."}},"httpPath":"/reporting/v1/customviews"},{"label":"Returns data for a specific reporting view","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/opportunity-assessor/apis/reporting-by-portfolio/reporting/getcustomviewdatabyidv2","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-portfolio/reporting/getcustomviewdatabyidv2","metadata":{"seo":{"title":"Returns data for a specific reporting view","description":"The results are paged when the number of records exceed the provided limit. Multiple calls may be required to retrieve all records. Header data is repeated for all pages."}},"httpPath":"/reporting/v2/customviewdata/{id}"},{"label":"Returns data for a specific reporting view","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/opportunity-assessor/apis/reporting-by-portfolio/reporting/getcustomviewdatabyid","routeSlug":"/solutions/opportunity-assessor/apis/reporting-by-portfolio/reporting/getcustomviewdatabyid","metadata":{"seo":{"title":"Returns data for a specific reporting view","description":"v1/customviewdata is deprecated. Use v2/customviewdata instead."}},"httpPath":"/reporting/v1/customviewdata/{id}"}]}],"metadata":{"type":"openapi","title":"Reporting by portfolio","version":"1","description":"The endpoints also include custom views. These views can be used to report multiple data object across the full portfolio in Geox and Opportunity Assessor.
All physical quantities in the responses are returned in SI units.
If you know the ID of the custom view you want to read, you can get the data directly through the custom view data by ID endpoint. Alternatively you can get all custom views and find the ID that way.
\n\n\n```plain {% title=\"Client ID\" %}\nedf17d1f8cc3461d8ba3f1a98ce7be1b\n```"}}]},{"type":"group","label":"Flow Assurance","items":[{"type":"group","fsPath":"solutions/flow-assurance/apis/FA-Job-Service.yaml","link":"/solutions/flow-assurance/apis/fa-job-service","routeSlug":"/solutions/flow-assurance/apis/fa-job-service","label":"FA-Job-Service","items":[{"type":"group","label":"Jobs","link":"/solutions/flow-assurance/apis/fa-job-service/jobs","routeSlug":"/solutions/flow-assurance/apis/fa-job-service/jobs","items":[{"label":"Get the job definition of a job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/flow-assurance/apis/fa-job-service/jobs/getjob","routeSlug":"/solutions/flow-assurance/apis/fa-job-service/jobs/getjob","metadata":{"seo":{"title":"Get the job definition of a job","description":"Get the job definition of a job"}},"httpPath":"/jobs/{jobID}"},{"label":"Get the job definition of a job by version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/flow-assurance/apis/fa-job-service/jobs/getjobbyversion","routeSlug":"/solutions/flow-assurance/apis/fa-job-service/jobs/getjobbyversion","metadata":{"seo":{"title":"Get the job definition of a job by version","description":"Get the job definition of a job by version"}},"httpPath":"/jobs/{jobID}/versions/{version}"},{"label":"Get all the file contents for a given job and file source as a zip","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/flow-assurance/apis/fa-job-service/jobs/getfilesbyjobid","routeSlug":"/solutions/flow-assurance/apis/fa-job-service/jobs/getfilesbyjobid","metadata":{"seo":{"title":"Get all the file contents for a given job and file source as a zip","description":"Get all the file contents for a given job and file source as a zip"}},"httpPath":"/jobs/{jobID}/files/{fileSource}"},{"label":"Get all the files information for a given job and file source","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/flow-assurance/apis/fa-job-service/jobs/getfilelistbyjobid","routeSlug":"/solutions/flow-assurance/apis/fa-job-service/jobs/getfilelistbyjobid","metadata":{"seo":{"title":"Get all the files information for a given job and file source","description":"Get all the files information for a given job and file source"}},"httpPath":"/jobs/{jobID}/files/{fileSource}/list"},{"label":"Get the file content for a given job, file source and file name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/flow-assurance/apis/fa-job-service/jobs/getfilebyjobidandfilename","routeSlug":"/solutions/flow-assurance/apis/fa-job-service/jobs/getfilebyjobidandfilename","metadata":{"seo":{"title":"Get the file content for a given job, file source and file name","description":"Get the file content for a given job, file source and file name"}},"httpPath":"/jobs/{jobID}/files/{fileSource}/{fileName}"},{"label":"Get the status of a job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/flow-assurance/apis/fa-job-service/jobs/getjobstatus","routeSlug":"/solutions/flow-assurance/apis/fa-job-service/jobs/getjobstatus","metadata":{"seo":{"title":"Get the status of a job","description":"It should only be called by the Job handlers in FA job service."}},"httpPath":"/jobs/{jobID}/status"},{"label":"Get the list of timed-out jobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/flow-assurance/apis/fa-job-service/jobs/gettimedoutjobs","routeSlug":"/solutions/flow-assurance/apis/fa-job-service/jobs/gettimedoutjobs","metadata":{"seo":{"title":"Get the list of timed-out jobs","description":"Get the list of timed-out jobs"}},"httpPath":"/jobs/timed-out"}]},{"type":"group","label":"Job Types","link":"/solutions/flow-assurance/apis/fa-job-service/job-types","routeSlug":"/solutions/flow-assurance/apis/fa-job-service/job-types","items":[{"label":"Get the job type and versions which Job-service can support","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/flow-assurance/apis/fa-job-service/job-types/getjobtypes","routeSlug":"/solutions/flow-assurance/apis/fa-job-service/job-types/getjobtypes","metadata":{"seo":{"title":"Get the job type and versions which Job-service can support","description":"Get the job type and versions which Job-service can support"}},"httpPath":"/jobtypes"}]}],"metadata":{"type":"openapi","title":"Job service","version":"1.0.0","description":"The Flow Assurance (FA) Job Service is designed to support a wide\n range of jobs, accommodating various job types supported by services. This includes,\n but is not limited to, specialized jobs like PipeSim PTK and EESy jobs. The service\n is flexible, handling both individual and composite jobs.\n\n A single job setup typically includes the job type, necessary input and output\n files, and specific job parameters. Composite jobs, on the other hand, are an\n assembly of these single job units, structured to operate collectively.\n {% admonition type=\"warning\" name=\"\" %}\n Restricted Access ! \n\n Existing customer can request access via [Customer Support for Digital](https://customersupport.digital.slb.com/).\n\n Automatic population of the API Key and S‑Auth token is not supported in the “Try It” interface for this API.\n {% /admonition %}\n```plain {% title=\"Client ID\" %}\ncore-flowassurance.slbservice.com\n```\n"}},{"type":"group","fsPath":"solutions/flow-assurance/apis/FA-OLGA-Simulation-Service.yaml","link":"/solutions/flow-assurance/apis/fa-olga-simulation-service","routeSlug":"/solutions/flow-assurance/apis/fa-olga-simulation-service","label":"FA-OLGA-Simulation-Service","items":[{"label":"Run OLGA simulation with model files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/flow-assurance/apis/fa-olga-simulation-service/other/postolgav1","routeSlug":"/solutions/flow-assurance/apis/fa-olga-simulation-service/other/postolgav1","metadata":{"seo":{"title":"Run OLGA simulation with model files","description":"This endpoint initiates an OLGA simulation using provided well model files and parameters. Clients must provide a ZIP archive containing a \".genkey\" file and possibly other files including \".tab\" files."}},"httpPath":"/jobs"},{"label":"Run OLGA Simulation with a pre-saved model by modelVersionId","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/flow-assurance/apis/fa-olga-simulation-service/other/postolgav2","routeSlug":"/solutions/flow-assurance/apis/fa-olga-simulation-service/other/postolgav2","metadata":{"seo":{"title":"Run OLGA Simulation with a pre-saved model by modelVersionId","description":"This endpoint allows running a simulation using a pre-saved model version. Clients provide the model version ID. Optionally, an 'operationalDatafile' file containing operation data can also be provided."}},"httpPath":"/jobs/{modelVersionId}"},{"label":"Run parametric study","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/flow-assurance/apis/fa-olga-simulation-service/other/postparametricstudy","routeSlug":"/solutions/flow-assurance/apis/fa-olga-simulation-service/other/postparametricstudy","metadata":{"seo":{"title":"Run parametric study","description":"This endpoint initiates a parametric study for the given model version ID by starting multiple OLGA simulations based on varying parameters defined in the studyName."}},"httpPath":"/jobs/{modelVersionId}/parametricStudy"}],"metadata":{"type":"openapi","title":"OLGA Simulation Service","version":"2.0.1","description":"This service provides an interface to the OLGA dynamic multiphase\n flow simulator, enabling clients to run simulations based on specific well models,\n parameters, and fluids.\n {% admonition type=\"warning\" name=\"\" %}\n Restricted Access ! \n\n Existing customer can request access via [Customer Support for Digital](https://customersupport.digital.slb.com/).\n\n Automatic population of the API Key and S‑Auth token is not supported in the “Try It” interface for this API.\n {% /admonition %}\n```plain {% title=\"Client ID\" %}\ncore-flowassurance.slbservice.com\n```\n"}}]},{"type":"group","label":"Managed Planning Data Foundation","items":[{"type":"group","label":"Core Services","items":[{"type":"group","fsPath":"solutions/core-service/apis/OSDU-CRS-Catalog-Service-V2.yaml","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2","label":"CRS Catalog Service","items":[{"type":"group","label":"CRS catalog","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/crs-catalog","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/crs-catalog","items":[{"label":"Get the Catalog summary (without lists)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/crs-catalog/get catalog summary","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/crs-catalog/get catalog summary","metadata":{"seo":{"title":"Get the Catalog summary (without lists)","description":"Get the catalog structure with populated number of items per list but empty lists ('lateBoundCRSes',...). It is expected that the lists are individually populated on demand via the specific methods ('CRSV2GetLateBoundCRSes',...)."}},"httpPath":"/catalog"},{"label":"Get Catalog Name and Update Dates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/crs-catalog/get catalog attributes","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/crs-catalog/get catalog attributes","metadata":{"seo":{"title":"Get Catalog Name and Update Dates","description":"Get the catalog name and last update date"}},"httpPath":"/catalog/attributes"}]},{"type":"group","label":"Cartographic Transformations","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations","items":[{"label":"Get all Cartographic Transformations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/get all ct","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/get all ct","metadata":{"seo":{"title":"Get all Cartographic Transformations","description":"Get all cartographic transformations declared in the catalog."}},"httpPath":"/ct"},{"label":"Get one Cartographic Transformation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/get one ct","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/get one ct","metadata":{"seo":{"title":"Get one Cartographic Transformation","description":"Get one cartographic transformation given its essence"}},"httpPath":"/ct"},{"label":"Get all CompoundCTs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/get all compoundct","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/get all compoundct","metadata":{"seo":{"title":"Get all CompoundCTs","description":"Get all the CompoundCTs defined in the catalog."}},"httpPath":"/compoundct"},{"label":"Get one CompoundCT","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/get one compoundct","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/get one compoundct","metadata":{"seo":{"title":"Get one CompoundCT","description":"Get one CompoundCT by its essence."}},"httpPath":"/compoundct"},{"label":"Get all SingleCTs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/get all singlect","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/get all singlect","metadata":{"seo":{"title":"Get all SingleCTs","description":"Get all the SingleCTs defined in the catalog."}},"httpPath":"/singlect"},{"label":"Get one SingleCT","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/get one singlect","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/get one singlect","metadata":{"seo":{"title":"Get one SingleCT","description":"Get one SingleCT given its essence."}},"httpPath":"/singlect"},{"label":"Search Cartographic Transformations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/search ct","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/cartographic-transformations/search ct","metadata":{"seo":{"title":"Search Cartographic Transformations","description":"Search cartographic transform records (any sub-type) by keywords and/or geographic area. Geographical constraints are passed (optionally) as parameters via the query URL, search keywords are passed via the request body. Query syntax follows Lucene style, default operator for multiple expressions is AND. The following keywords are supported: 'name:','description:', 'type:', 'authority:', 'code:', 'deprecationState:', 'remarks:', 'lastModified:', 'source:', 'wellKnownText:', 'fromCRS.authority:', 'fromCRS.code:', 'toCRS.authority:', toCRS.code:', 'policy:'. followed by a value. Example: 'fromCRS.code:4267'. longitudeLeft - the left WGS 84 longitude limit of the search box. latitudeLower - the lower WGS 84 latitude limit of the search box. longitudeRight - the right WGS 84 longitude limit of the search box. latitudeUpper - The upper WGS 84 latitude limit of the search box."}},"httpPath":"/search/ct"}]},{"type":"group","label":"Areas of Use","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/areas-of-use","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/areas-of-use","items":[{"label":"Get Areas of Use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/areas-of-use/get all areas of use","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/areas-of-use/get all areas of use","metadata":{"seo":{"title":"Get Areas of Use","description":"Get Area of Use records - returning named bounding box definitions in latitude and longitude."}},"httpPath":"/area"},{"label":"Get one Area of Use","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/areas-of-use/get one area of use","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/areas-of-use/get one area of use","metadata":{"seo":{"title":"Get one Area of Use","description":"Get one Area of Use record by essence - returning a named bounding box definition in latitude and longitude."}},"httpPath":"/area"},{"label":"Search Areas of Use","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/areas-of-use/search area of use","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/areas-of-use/search area of use","metadata":{"seo":{"title":"Search Areas of Use","description":"Search Area of Use records by keywords and/or geographic area - returning named bounding box definitions in latitude and longitude. Geographical constraints are passed (optionally) as parameters via the query URL, search keywords are passed via the request body. Query syntax follows Lucene style, default operator for multiple expressions is AND. The following keywords are supported: 'name:', 'description:', 'authority:', 'code:', 'deprecationState:', 'remarks:' (deprecationState remarks), 'lastModified:'. Example 'name:America'. longitudeLeft - the left WGS 84 longitude limit of the search box. latitudeLower - the lower WGS 84 latitude limit of the search box. longitudeRight - the right WGS 84 longitude limit of the search box. latitudeUpper - The upper WGS 84 latitude limit of the search box."}},"httpPath":"/search/area"}]},{"type":"group","label":"Coordinate Reference Systems","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems","items":[{"label":"Get all CRSes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get all crs","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get all crs","metadata":{"seo":{"title":"Get all CRSes","description":"Get all the CRSes (any sub-type) defined in the catalog."}},"httpPath":"/crs"},{"label":"Get one CRS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get one crs","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get one crs","metadata":{"seo":{"title":"Get one CRS","description":"Get one CRS (any sub-type) given its essence"}},"httpPath":"/crs"},{"label":"Get all CompoundCRSes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get all compoundcrs","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get all compoundcrs","metadata":{"seo":{"title":"Get all CompoundCRSes","description":"Get all the CompoundCRSes defined in the catalog."}},"httpPath":"/compoundcrs"},{"label":"Get one CompoundCRS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get one compoundcrs","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get one compoundcrs","metadata":{"seo":{"title":"Get one CompoundCRS","description":"Get one the CompoundCRS given its essence."}},"httpPath":"/compoundcrs"},{"label":"Get all EarlyBoundCRSes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get all earlyboundcrs","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get all earlyboundcrs","metadata":{"seo":{"title":"Get all EarlyBoundCRSes","description":"Get all the EarlyBoundCRSes defined in the catalog."}},"httpPath":"/earlyboundcrs"},{"label":"Get one EarlyBoundCRS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get one earlyboundcrs","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get one earlyboundcrs","metadata":{"seo":{"title":"Get one EarlyBoundCRS","description":"Get one EarlyBoundCRS given its essence"}},"httpPath":"/earlyboundcrs"},{"label":"Get all LateBoundCRSes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get all lateboundcrs","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get all lateboundcrs","metadata":{"seo":{"title":"Get all LateBoundCRSes","description":"Get all the LateBoundCRSes defined in the catalog."}},"httpPath":"/lateboundcrs"},{"label":"Get one LateBoundCRS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get one lateboundcrs","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/get one lateboundcrs","metadata":{"seo":{"title":"Get one LateBoundCRS","description":"Get one LateBoundCRS given its persistable reference string or essence structure."}},"httpPath":"/lateboundcrs"},{"label":"Search CRSes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/search crs","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/coordinate-reference-systems/search crs","metadata":{"seo":{"title":"Search CRSes","description":"Search CRS records (any sub-type) by keywords and/or geographic area. Geographical constraints are passed (optionally) as parameters via the query URL, search keywords are passed via the request body. Query syntax follows Lucene style, default operator for multiple expressions is AND. The following keywords are supported: 'name:', 'description:', 'type:', 'authority:', 'code:', 'deprecationState:', 'remarks:', 'lastModified:', 'source:', 'wellKnownText:', 'crsType:', 'baseCRS.authority:', 'baseCRS.code:', 'horizontalCRS.authority:', 'horizontalCRS.code:', 'verticalCRS.authority:', 'verticalCRS.code:', 'lateBoundCRS.authority:', 'lateBoundCRS.code:', 'ct.authority:', 'ct.code:', 'transformationReady:'. followed by a value. Example: 'transformationReady:true'. longitudeLeft - the left WGS 84 longitude limit of the search box. latitudeLower - the lower WGS 84 latitude limit of the search box. longitudeRight - the right WGS 84 longitude limit of the search box. latitudeUpper - The upper WGS 84 latitude limit of the search box."}},"httpPath":"/search/crs"}]},{"type":"group","label":"Info","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/info","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/info","items":[{"label":"Version info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/info/version info","routeSlug":"/solutions/core-service/apis/osdu-crs-catalog-service-v2/info/version info","metadata":{"seo":{"title":"Version info","description":"For deployment available public /info endpoint, which provides build and git related information."}},"httpPath":"/info"}]}],"metadata":{"type":"openapi","title":"CRS Catalog Service API","version":"2.0.0","description":"Coordinate Reference System (CRS) Catalog Service\n\n```plain {% title=\"Client ID\" %}\n963f2cc6915e479fa0fcb73ec2ec90e7\n```\n"}},{"type":"group","fsPath":"solutions/core-service/apis/OSDU-CRS-Converter-Service.yaml","link":"/solutions/core-service/apis/osdu-crs-converter-service","routeSlug":"/solutions/core-service/apis/osdu-crs-converter-service","label":"CRS Converter Service","items":[{"type":"group","label":"CRS Point Conversion","link":"/solutions/core-service/apis/osdu-crs-converter-service/crs-point-conversion","routeSlug":"/solutions/core-service/apis/osdu-crs-converter-service/crs-point-conversion","items":[{"label":"Convert a list of points","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-converter-service/crs-point-conversion/convertpoint","routeSlug":"/solutions/core-service/apis/osdu-crs-converter-service/crs-point-conversion/convertpoint","metadata":{"seo":{"title":"Convert a list of points","description":"Convert a list of points"}},"httpPath":"/convert"},{"label":"Convert a GeoJSON or AnyCrsGeoJson structure","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-converter-service/crs-point-conversion/convertgeojson","routeSlug":"/solutions/core-service/apis/osdu-crs-converter-service/crs-point-conversion/convertgeojson","metadata":{"seo":{"title":"Convert a GeoJSON or AnyCrsGeoJson structure","description":"Convert a GeoJSON or AnyCrsGeoJson structure to a specified target CRS. GeoJSON is declared - by definition - to be in the context of WGS 84."}},"httpPath":"/convertGeoJson"}]},{"type":"group","label":"Trajectory Computation and Conversion","link":"/solutions/core-service/apis/osdu-crs-converter-service/trajectory-computation-and-conversion","routeSlug":"/solutions/core-service/apis/osdu-crs-converter-service/trajectory-computation-and-conversion","items":[{"label":"Convert trajectory stations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-converter-service/trajectory-computation-and-conversion/converttrajectory","routeSlug":"/solutions/core-service/apis/osdu-crs-converter-service/trajectory-computation-and-conversion/converttrajectory","metadata":{"seo":{"title":"Convert trajectory stations","description":"Convert a list of trajectory stations, given the unit and spatial context and a reference point in 3D where MD = 0."}},"httpPath":"/convertTrajectory"}]},{"type":"group","label":"Info","link":"/solutions/core-service/apis/osdu-crs-converter-service/info","routeSlug":"/solutions/core-service/apis/osdu-crs-converter-service/info","items":[{"label":"Version info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-crs-converter-service/info/version info","routeSlug":"/solutions/core-service/apis/osdu-crs-converter-service/info/version info","metadata":{"seo":{"title":"Version info","description":"For deployment available public /info endpoint, which provides build and git related information."}},"httpPath":"/info"}]}],"metadata":{"type":"openapi","title":"CRS Conversion Service","version":"1.0.0","description":"Provides conversion/transformation services from a source to a target CRS. A coordinate operation is a conversion if the source and target CRS share the same datum; the operation is called transformation if datum transformations are involved, i.e. source and target CRS do not share the same datum.\n\n```plain {% title=\"Client ID\" %}\n963f2cc6915e479fa0fcb73ec2ec90e7\n```\n"}},{"type":"group","fsPath":"solutions/core-service/apis/OSDU-Dataset-Service.yaml","link":"/solutions/core-service/apis/osdu-dataset-service","routeSlug":"/solutions/core-service/apis/osdu-dataset-service","label":"Dataset Service","items":[{"type":"group","label":"dataset-dms-api","link":"/solutions/core-service/apis/osdu-dataset-service/dataset-dms-api","routeSlug":"/solutions/core-service/apis/osdu-dataset-service/dataset-dms-api","items":[{"label":"retrievalInstructions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-dataset-service/dataset-dms-api/retrievalinstructionsusingget","routeSlug":"/solutions/core-service/apis/osdu-dataset-service/dataset-dms-api/retrievalinstructionsusingget","metadata":{"seo":{"title":"retrievalInstructions","description":"Gets a signed URL for downloading a single file associated with the unique id of the file. (similar to /downloadURL in File Service)."}},"httpPath":"/retrievalInstructions"},{"label":"retrievalInstructions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-dataset-service/dataset-dms-api/retrievalinstructionsusingpost","routeSlug":"/solutions/core-service/apis/osdu-dataset-service/dataset-dms-api/retrievalinstructionsusingpost","metadata":{"seo":{"title":"retrievalInstructions","description":"Gets a list of signed URLs to download multiple files by providing a list of file ids."}},"httpPath":"/retrievalInstructions"},{"label":"storageInstructions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-dataset-service/dataset-dms-api/storageinstructionsusingpost","routeSlug":"/solutions/core-service/apis/osdu-dataset-service/dataset-dms-api/storageinstructionsusingpost","metadata":{"seo":{"title":"storageInstructions","description":"Gets a temporary signed URL to upload a dataset (File or collection of files. Service does not upload the file by itself, User needs to use this URL to upload the file). The generated URL is time bound and by default expires by 7 days maximum."}},"httpPath":"/storageInstructions"},{"label":"Revoke previously generated URLs for Dataset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-dataset-service/dataset-dms-api/revokepreviouslygeneratedurlsusingpost","routeSlug":"/solutions/core-service/apis/osdu-dataset-service/dataset-dms-api/revokepreviouslygeneratedurlsusingpost","metadata":{"seo":{"title":"Revoke previously generated URLs for Dataset","description":"Revoke previously generated URLs associated with a specific dataset kind subtype (Eg - dataset--File.Generic)."}},"httpPath":"/revokeURL"}]},{"type":"group","label":"dataset-registry-api","link":"/solutions/core-service/apis/osdu-dataset-service/dataset-registry-api","routeSlug":"/solutions/core-service/apis/osdu-dataset-service/dataset-registry-api","items":[{"label":"getDatasetRegistry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-dataset-service/dataset-registry-api/getdatasetregistryusingget","routeSlug":"/solutions/core-service/apis/osdu-dataset-service/dataset-registry-api/getdatasetregistryusingget","metadata":{"seo":{"title":"getDatasetRegistry","description":"Gets the latest version of Dataset Registry record identified by the given id (similar to GET /{id}/metadata in File Service)."}},"httpPath":"/getDatasetRegistry"},{"label":"getDatasetRegistry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-dataset-service/dataset-registry-api/getdatasetregistryusingpost","routeSlug":"/solutions/core-service/apis/osdu-dataset-service/dataset-registry-api/getdatasetregistryusingpost","metadata":{"seo":{"title":"getDatasetRegistry","description":"Gets list of Dataset Registy records identified by a list of IDs."}},"httpPath":"/getDatasetRegistry"},{"label":"createOrUpdateDatasetRegistry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-dataset-service/dataset-registry-api/createorupdatedatasetregistryusingput","routeSlug":"/solutions/core-service/apis/osdu-dataset-service/dataset-registry-api/createorupdatedatasetregistryusingput","metadata":{"seo":{"title":"createOrUpdateDatasetRegistry","description":"This API registers dataset metadata record for a file that is already uploaded. The Metadata is linked to the file via FileSource provided in the request body."}},"httpPath":"/registerDataset"}]},{"type":"group","label":"Info","link":"/solutions/core-service/apis/osdu-dataset-service/info","routeSlug":"/solutions/core-service/apis/osdu-dataset-service/info","items":[{"label":"Version info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/core-service/apis/osdu-dataset-service/info/version info","routeSlug":"/solutions/core-service/apis/osdu-dataset-service/info/version info","metadata":{"seo":{"title":"Version info","description":"For deployment available public /info endpoint, which provides build and git related information."}},"httpPath":"/info"}]}],"metadata":{"type":"openapi","title":"Dataset Service Api","version":"1.0","description":"The Dataset service provides API endpoints to allow an application or user to register datasets in Data Platform.Required roles: 'users.datalake.editors' or 'users.datalake.admins'.
"}},"httpPath":"/upload-catalog"}]}],"metadata":{"type":"openapi","title":"Log Recognition OSDU","version":"0.2","description":"Log recognition servicen\n\n\n```plain {% title=\"ClientID\" %}\n963f2cc6915e479fa0fcb73ec2ec90e7\n```"}},{"type":"group","fsPath":"solutions/wellbore-dms/apis/Delfi-WDMS-reference.json","link":"/solutions/wellbore-dms/apis/delfi-wdms-reference","routeSlug":"/solutions/wellbore-dms/apis/delfi-wdms-reference","label":"Reference Service- Enterprise Data Extension","items":[{"type":"group","label":"Reference","link":"/solutions/wellbore-dms/apis/delfi-wdms-reference/reference","routeSlug":"/solutions/wellbore-dms/apis/delfi-wdms-reference/reference","items":[{"label":"Returns a WellboreTrajectory record id enriched with trajectory stations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/delfi-wdms-reference/reference/complete_trajectory_response","routeSlug":"/solutions/wellbore-dms/apis/delfi-wdms-reference/reference/complete_trajectory_response","metadata":{"seo":{"title":"Returns a WellboreTrajectory record id enriched with trajectory stations","description":"Returns a WellboreTrajectory record id enriched with trajectory stations resulting from the OSDU trajectory computation service.This API is taking as input a WellboreTrajectory ID and execute the following steps:"}},"httpPath":"/wellboretrajectories/{wellbore_trajectory_id}/compute"},{"label":"Return the data of the given WellLog in the targeted reference.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/delfi-wdms-reference/reference/get_tvd_welllogs__record_id__data_get","routeSlug":"/solutions/wellbore-dms/apis/delfi-wdms-reference/reference/get_tvd_welllogs__record_id__data_get","metadata":{"seo":{"title":"Return the data of the given WellLog in the targeted reference.","description":"Return the data of the given WellLog in the targeted reference.The targeted reference can be chosen between TVD and TVDSS.The targeted reference is computed using the data of the definitive trajectory of the Wellbore associated to this WellLog.If the targeted reference is not present in the definitive trajectory of the parent wellbore, a 404 error message is returned in the response.It is better for performances to use this API to get MD and targeted_reference only by setting curves to None and a second call if needed throught WDMS WellLog bulk data API to get the curves using indexes returned in the response of the first API call."}},"httpPath":"/welllogs/{record_id}/data"},{"label":"Return the data of the given WellLog in the targeted reference.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/delfi-wdms-reference/reference/get_tvd_version_welllogs__record_id__versions__version__data_get","routeSlug":"/solutions/wellbore-dms/apis/delfi-wdms-reference/reference/get_tvd_version_welllogs__record_id__versions__version__data_get","metadata":{"seo":{"title":"Return the data of the given WellLog in the targeted reference.","description":"Return the data of the given WellLog in the targeted reference.The targeted reference can be chosen between TVD and TVDSS.The targeted reference is computed using the data of the definitive trajectory of the Wellbore associated to this WellLog.If the targeted reference is not present in the definitive trajectory of the parent wellbore, a 404 error message is returned in the response.It is better for performances to use this API to get MD and targeted_reference only by setting curves to None and a second call if needed throught WDMS WellLog bulk data API to get the curves using indexes returned in the response of the first API call."}},"httpPath":"/welllogs/{record_id}/versions/{version}/data"}]}],"metadata":{"type":"openapi","title":"OSDU Wellbore DMS","version":"3.0.0","description":"OSDU Wellbore DMS openAPI specification\n\n\n```plain {% title=\"ClientID\" %}\n963f2cc6915e479fa0fcb73ec2ec90e7\n```"}},{"type":"group","fsPath":"solutions/wellbore-dms/apis/WDMS-OSDU-DA-v3.json","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3","label":"Wellbore Data Access V3","items":[{"type":"group","label":"Wellbore","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore","items":[{"label":"Create or update the Wellbores using osdu schema","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore/post_wellbore_osdu","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore/post_wellbore_osdu","metadata":{"seo":{"title":"Create or update the Wellbores using osdu schema","description":"Required roles: 'users.datalake.editors' or 'users.datalake.admins"}},"httpPath":"/wellbores"},{"label":"Delete the wellbore. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore/del_osdu_wellbore","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore/del_osdu_wellbore","metadata":{"seo":{"title":"Delete the wellbore. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds","description":"Required roles: 'users.datalake.editors' or 'users.datalake.admins"}},"httpPath":"/wellbores/{wellboreid}"},{"label":"Get the Wellbore using osdu schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore/get_wellbore_osdu","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore/get_wellbore_osdu","metadata":{"seo":{"title":"Get the Wellbore using osdu schema","description":"Get the Wellbore object using its id.Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.In addition, users must be a member of data groups to access the data."}},"httpPath":"/wellbores/{wellboreid}"},{"label":"Get all versions of the Wellbore","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore/get_osdu_wellbore_versions","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore/get_osdu_wellbore_versions","metadata":{"seo":{"title":"Get all versions of the Wellbore","description":"Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data."}},"httpPath":"/wellbores/{wellboreid}/versions"},{"label":"Get the given version of the Wellbore using OSDU wellbore schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore/get_osdu_wellbore_version","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore/get_osdu_wellbore_version","metadata":{"seo":{"title":"Get the given version of the Wellbore using OSDU wellbore schema","description":"\"Get the Wellbore object using its id.Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.In addition, users must be a member of data groups to access the data."}},"httpPath":"/wellbores/{wellboreid}/versions/{version}"}]},{"type":"group","label":"Well","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/well","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/well","items":[{"label":"Create or update the Wells using osdu schema","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/well/post_well_osdu","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/well/post_well_osdu","metadata":{"seo":{"title":"Create or update the Wells using osdu schema","description":"Required roles: 'users.datalake.editors' or 'users.datalake.admins"}},"httpPath":"/wells"},{"label":"Delete the well. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/well/del_osdu_well","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/well/del_osdu_well","metadata":{"seo":{"title":"Delete the well. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds","description":"Required roles: 'users.datalake.editors' or 'users.datalake.admins"}},"httpPath":"/wells/{wellid}"},{"label":"Get the Well using osdu schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/well/get_well_osdu","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/well/get_well_osdu","metadata":{"seo":{"title":"Get the Well using osdu schema","description":"Get the Well object using its id.Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.In addition, users must be a member of data groups to access the data."}},"httpPath":"/wells/{wellid}"},{"label":"Get all versions of the Well","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/well/get_osdu_well_versions","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/well/get_osdu_well_versions","metadata":{"seo":{"title":"Get all versions of the Well","description":"Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data."}},"httpPath":"/wells/{wellid}/versions"},{"label":"Get the given version of the Well using OSDU well schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/well/get_osdu_well_version","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/well/get_osdu_well_version","metadata":{"seo":{"title":"Get the given version of the Well using OSDU well schema","description":"\"Get the Well object using its id.Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.In addition, users must be a member of data groups to access the data."}},"httpPath":"/wells/{wellid}/versions/{version}"}]},{"type":"group","label":"WellLog","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog","items":[{"label":"Delete the welllog. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/del_osdu_welllog","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/del_osdu_welllog","metadata":{"seo":{"title":"Delete the welllog. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds","description":"Required roles: 'users.datalake.editors' or 'users.datalake.admins"}},"httpPath":"/welllogs/{welllogid}"},{"label":"Get the WellLog using osdu schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get_welllog_osdu","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get_welllog_osdu","metadata":{"seo":{"title":"Get the WellLog using osdu schema","description":"Get the WellLog object using its id.Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.In addition, users must be a member of data groups to access the data."}},"httpPath":"/welllogs/{welllogid}"},{"label":"Get all versions of the WellLog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get_osdu_welllog_versions","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get_osdu_welllog_versions","metadata":{"seo":{"title":"Get all versions of the WellLog","description":"Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data."}},"httpPath":"/welllogs/{welllogid}/versions"},{"label":"Get the given version of the WellLog using OSDU welllog schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get_osdu_welllog_version","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get_osdu_welllog_version","metadata":{"seo":{"title":"Get the given version of the WellLog using OSDU welllog schema","description":"\"Get the WellLog object using its id.Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.In addition, users must be a member of data groups to access the data."}},"httpPath":"/welllogs/{welllogid}/versions/{version}"},{"label":"Create or update the WellLogs using osdu schema","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/post_welllog_osdu","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/post_welllog_osdu","metadata":{"seo":{"title":"Create or update the WellLogs using osdu schema","description":"Required roles: 'users.datalake.editors' or 'users.datalake.admins"}},"httpPath":"/welllogs"},{"label":"Returns the data according to the specified query parameters.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get__ddms_v3_welllogs__record_id__data","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get__ddms_v3_welllogs__record_id__data","metadata":{"seo":{"title":"Returns the data according to the specified query parameters.","description":"Returns the data according to the specified query parameters.Multiple media types response are available (\"application/json\", \"application/x-parquet\").The desired format can be specify in the \"Accept\" header, default is Parquet."}},"httpPath":"/welllogs/{record_id}/data"},{"label":"Writes data as a whole bulk, creates a new version.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/write_record_data","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/write_record_data","metadata":{"seo":{"title":"Writes data as a whole bulk, creates a new version.","description":"Writes data to the associated record. It creates a new version.Payload is expected to contain the entire bulk which will replace as latest versionany previous bulk. Previous bulk versions are accessible via the get bulk data version API.Support JSON and Parquet format ('Content_Type' must be set accordingly).Support http chunked encoding transfer."}},"httpPath":"/welllogs/{record_id}/data"},{"label":"Returns statistics of record's data for selected curves","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get__ddms_v3_welllogs__record_id__data_statistics","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get__ddms_v3_welllogs__record_id__data_statistics","metadata":{"seo":{"title":"Returns statistics of record's data for selected curves","description":"Returns the statistics on bulk data identified by the record in its last version."}},"httpPath":"/welllogs/{record_id}/data/statistics"},{"label":"list session of the given record.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get__ddms_v3_welllogs__record_id__sessions","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get__ddms_v3_welllogs__record_id__sessions","metadata":{"seo":{"title":"list session of the given record.","description":"list session of the given record."}},"httpPath":"/welllogs/{record_id}/sessions"},{"label":"Create a new session on the given record for writing bulk data.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/post__ddms_v3_welllogs__record_id__sessions","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/post__ddms_v3_welllogs__record_id__sessions","metadata":{"seo":{"title":"Create a new session on the given record for writing bulk data.","description":"Initiate a session based on record version provided. The session is isolated from any other modifications.Inside a session, individual chunk doesn't generate new individual record version."}},"httpPath":"/welllogs/{record_id}/sessions"},{"label":"get session.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get__ddms_v3_welllogs__record_id__sessions__session_id_","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get__ddms_v3_welllogs__record_id__sessions__session_id_","metadata":{"seo":{"title":"get session.","description":"get session."}},"httpPath":"/welllogs/{record_id}/sessions/{session_id}"},{"label":"Update a session, either commit or abandon.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/patch__ddms_v3_welllogs__record_id__sessions__session_id_","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/patch__ddms_v3_welllogs__record_id__sessions__session_id_","metadata":{"seo":{"title":"Update a session, either commit or abandon.","description":"Either validates the session' bulk data, a new version of record will be created with data sent within the session. Either abandon the session, and let record unchanged. Note: bulk data consistency check will be run when committing bulk data."}},"httpPath":"/welllogs/{record_id}/sessions/{session_id}"},{"label":"Send a data chunk. Session must be complete/commit once all chunks are sent.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/post_chunk_data","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/post_chunk_data","metadata":{"seo":{"title":"Send a data chunk. Session must be complete/commit once all chunks are sent.","description":"Send a data chunk. Session must be complete/commit once all chunks are sent. This will create a new and single version aggregating all and previous bulk.Support JSON and Parquet format ('Content_Type' must be set accordingly). Support http chunked encoding.Required roles: 'users.datalake.editors' or 'users.datalake.admins"}},"httpPath":"/welllogs/{record_id}/sessions/{session_id}/data"},{"label":"Returns data of the specified version.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get__ddms_v3_welllogs__record_id__versions__version__data","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get__ddms_v3_welllogs__record_id__versions__version__data","metadata":{"seo":{"title":"Returns data of the specified version.","description":"Returns the data of a specific version according to the specified query parameters.Multiple media types response are available (\"application/json\", \"application/x-parquet\").The desired format can be specify in the \"Accept\" header, default is Parquet."}},"httpPath":"/welllogs/{record_id}/versions/{version}/data"},{"label":"Returns statistics of record's data for selected curves at requested version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get__ddms_v3_welllogs__record_id__versions__version__data_statistics","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/get__ddms_v3_welllogs__record_id__versions__version__data_statistics","metadata":{"seo":{"title":"Returns statistics of record's data for selected curves at requested version","description":"Returns the statistics on bulk data identified by the record and given version."}},"httpPath":"/welllogs/{record_id}/versions/{version}/data/statistics"},{"label":"Trigger computations of record's data statistics of record's data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/post__ddms_v3_welllogs__record_id__versions__version__data_statistics","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/welllog/post__ddms_v3_welllogs__record_id__versions__version__data_statistics","metadata":{"seo":{"title":"Trigger computations of record's data statistics of record's data","description":"Trigger the computation of statistics on bulk data forthe record identified by the record_id at its last version"}},"httpPath":"/welllogs/{record_id}/versions/{version}/data/statistics"}]},{"type":"group","label":"Trajectory v3","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3","items":[{"label":"Create or update the WellboreTrajectories using osdu schema","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/post_wellboretrajectory_osdu","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/post_wellboretrajectory_osdu","metadata":{"seo":{"title":"Create or update the WellboreTrajectories using osdu schema","description":"Required roles: 'users.datalake.editors' or 'users.datalake.admins"}},"httpPath":"/wellboretrajectories"},{"label":"Returns the data according to the specified query parameters.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get__ddms_v3_wellboretrajectories__record_id__data","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get__ddms_v3_wellboretrajectories__record_id__data","metadata":{"seo":{"title":"Returns the data according to the specified query parameters.","description":"Returns the data according to the specified query parameters.Multiple media types response are available (\"application/json\", \"application/x-parquet\").The desired format can be specify in the \"Accept\" header, default is Parquet."}},"httpPath":"/wellboretrajectories/{record_id}/data"},{"label":"Writes data as a whole bulk, creates a new version.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/post__ddms_v3_wellboretrajectories__record_id__data","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/post__ddms_v3_wellboretrajectories__record_id__data","metadata":{"seo":{"title":"Writes data as a whole bulk, creates a new version.","description":"Writes data to the associated record. It creates a new version.Payload is expected to contain the entire bulk which will replace as latest versionany previous bulk. Previous bulk versions are accessible via the get bulk data version API.Support JSON and Parquet format ('Content_Type' must be set accordingly).Support http chunked encoding transfer."}},"httpPath":"/wellboretrajectories/{record_id}/data"},{"label":"list session of the given record.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get__ddms_v3_wellboretrajectories__record_id__sessions","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get__ddms_v3_wellboretrajectories__record_id__sessions","metadata":{"seo":{"title":"list session of the given record.","description":"list session of the given record."}},"httpPath":"/wellboretrajectories/{record_id}/sessions"},{"label":"Create a new session on the given record for writing bulk data.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/post__ddms_v3_wellboretrajectories__record_id__sessions","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/post__ddms_v3_wellboretrajectories__record_id__sessions","metadata":{"seo":{"title":"Create a new session on the given record for writing bulk data.","description":"Initiate a session based on record version provided. The session is isolated from any other modifications.Inside a session, individual chunk doesn't generate new individual record version."}},"httpPath":"/wellboretrajectories/{record_id}/sessions"},{"label":"get session.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get__ddms_v3_wellboretrajectories__record_id__sessions__session_id_","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get__ddms_v3_wellboretrajectories__record_id__sessions__session_id_","metadata":{"seo":{"title":"get session.","description":"get session."}},"httpPath":"/wellboretrajectories/{record_id}/sessions/{session_id}"},{"label":"Update a session, either commit or abandon.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/patch__ddms_v3_wellboretrajectories__record_id__sessions__session_id_","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/patch__ddms_v3_wellboretrajectories__record_id__sessions__session_id_","metadata":{"seo":{"title":"Update a session, either commit or abandon.","description":"Either validates the session' bulk data, a new version of record will be created with data sent within the session. Either abandon the session, and let record unchanged. Note: bulk data consistency check will be run when committing bulk data."}},"httpPath":"/wellboretrajectories/{record_id}/sessions/{session_id}"},{"label":"Send a data chunk. Session must be complete/commit once all chunks are sent.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/post__ddms_v3_wellboretrajectories__record_id__sessions__session_id__data","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/post__ddms_v3_wellboretrajectories__record_id__sessions__session_id__data","metadata":{"seo":{"title":"Send a data chunk. Session must be complete/commit once all chunks are sent.","description":"Send a data chunk. Session must be complete/commit once all chunks are sent. This will create a new and single version aggregating all and previous bulk.Support JSON and Parquet format ('Content_Type' must be set accordingly). Support http chunked encoding.Required roles: 'users.datalake.editors' or 'users.datalake.admins"}},"httpPath":"/wellboretrajectories/{record_id}/sessions/{session_id}/data"},{"label":"Returns data of the specified version.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get__ddms_v3_wellboretrajectories__record_id__versions__version__data","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get__ddms_v3_wellboretrajectories__record_id__versions__version__data","metadata":{"seo":{"title":"Returns data of the specified version.","description":"Returns the data of a specific version according to the specified query parameters.Multiple media types response are available (\"application/json\", \"application/x-parquet\").The desired format can be specify in the \"Accept\" header, default is Parquet."}},"httpPath":"/wellboretrajectories/{record_id}/versions/{version}/data"},{"label":"Delete the wellboreTrajectory. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/del_osdu_wellboretrajectory","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/del_osdu_wellboretrajectory","metadata":{"seo":{"title":"Delete the wellboreTrajectory. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds","description":"Required roles: 'users.datalake.editors' or 'users.datalake.admins"}},"httpPath":"/wellboretrajectories/{wellboretrajectoryid}"},{"label":"Get the WellboreTrajectory using osdu schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get_wellbore_trajectory_osdu","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get_wellbore_trajectory_osdu","metadata":{"seo":{"title":"Get the WellboreTrajectory using osdu schema","description":"Get the WellboreTrajectory object using its id.Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.In addition, users must be a member of data groups to access the data."}},"httpPath":"/wellboretrajectories/{wellboretrajectoryid}"},{"label":"Get all versions of the WellboreTrajectory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get_osdu_wellboretrajectory_versions","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get_osdu_wellboretrajectory_versions","metadata":{"seo":{"title":"Get all versions of the WellboreTrajectory","description":"Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data."}},"httpPath":"/wellboretrajectories/{wellboretrajectoryid}/versions"},{"label":"Get the given version of the WellboreTrajectory using OSDU wellboreTrajectory schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get_osdu_wellboretrajectory_version","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/trajectory-v3/get_osdu_wellboretrajectory_version","metadata":{"seo":{"title":"Get the given version of the WellboreTrajectory using OSDU wellboreTrajectory schema","description":"\"Get the WellboreTrajectory object using its id.Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.In addition, users must be a member of data groups to access the data."}},"httpPath":"/wellboretrajectories/{wellboretrajectoryid}/versions/{version}"}]},{"type":"group","label":"Wellbore IntervalSet","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore-intervalset","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore-intervalset","items":[{"label":"Create or update the WellboreIntervalSet using osdu schema","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore-intervalset/post_wellboreintervalsetid_osdu","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore-intervalset/post_wellboreintervalsetid_osdu","metadata":{"seo":{"title":"Create or update the WellboreIntervalSet using osdu schema","description":"Required roles: 'users.datalake.editors' or 'users.datalake.admins"}},"httpPath":"/wellboreintervalsets"},{"label":"Delete the WellboreIntervalSetId. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore-intervalset/del_osdu_wellboreintervalsetid","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore-intervalset/del_osdu_wellboreintervalsetid","metadata":{"seo":{"title":"Delete the WellboreIntervalSetId. The API performs a logical deletion of the given record. No recursive delete for OSDU kinds","description":"Required roles: 'users.datalake.editors' or 'users.datalake.admins"}},"httpPath":"/wellboreintervalsets/{wellboreintervalsetsid}"},{"label":"Get the WellboreIntervalSet using osdu schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore-intervalset/get_wellboreintervalsetid_osdu","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore-intervalset/get_wellboreintervalsetid_osdu","metadata":{"seo":{"title":"Get the WellboreIntervalSet using osdu schema","description":"Get the WellboreIntervalSet object using its id.Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.In addition, users must be a member of data groups to access the data."}},"httpPath":"/wellboreintervalsets/{wellboreintervalsetsid}"},{"label":"Get all versions of the WellboreIntervalSet","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore-intervalset/get_osdu_wellboreintervalsetid_versions","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore-intervalset/get_osdu_wellboreintervalsetid_versions","metadata":{"seo":{"title":"Get all versions of the WellboreIntervalSet","description":"Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'. In addition, users must be a member of data groups to access the data."}},"httpPath":"/wellboreintervalsets/{wellboreintervalsetsid}/versions"},{"label":"Get the given version of the WellboreIntervalSet using OSDU WellboreIntervalSetId schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore-intervalset/get_osdu_wellboreintervalsetid_version","routeSlug":"/solutions/wellbore-dms/apis/wdms-osdu-da-v3/wellbore-intervalset/get_osdu_wellboreintervalsetid_version","metadata":{"seo":{"title":"Get the given version of the WellboreIntervalSet using OSDU WellboreIntervalSetId schema","description":"Get the WellboreIntervalSet object using its id.Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'.In addition, users must be a member of data groups to access the data."}},"httpPath":"/wellboreintervalsets/{wellboreintervalsetsid}/versions/{version}"}]}],"metadata":{"type":"openapi","title":"Wellbore DDMS OSDU","version":"3.0.0","description":"Data access for Well, Wellbore, WellLogs and Trajectories enabling the Consortium R3 data model\n\n\n```plain {% title=\"ClientID\" %}\n963f2cc6915e479fa0fcb73ec2ec90e7\n```"}}]}]},{"type":"group","label":"Reservoir Engineering","items":[{"type":"group","fsPath":"solutions/reservoir-engineering/apis/reservoir-engineering-ensembles.yaml","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-ensembles","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-ensembles","label":"Ensembles","items":[{"type":"link","label":"Key concepts","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-ensembles/section/key-concepts","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-ensembles/section/key-concepts"},{"type":"group","label":"ensembles-v2-experimental","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-ensembles/ensembles-v2-experimental","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-ensembles/ensembles-v2-experimental","items":[{"label":"Create a new ensemble","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-ensembles/ensembles-v2-experimental/postv2ensembles","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-ensembles/ensembles-v2-experimental/postv2ensembles","metadata":{"seo":{"title":"Create a new ensemble","description":"Create a new ensemble from simulation IDs."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v2/ensembles"},{"label":"Get ensemble files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-ensembles/ensembles-v2-experimental/getv2ensemblefiles","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-ensembles/ensembles-v2-experimental/getv2ensemblefiles","metadata":{"seo":{"title":"Get ensemble files","description":"Return the list of files associated with the ensemble. The file size and (when requested) file signed URL will be populated only if the file has been uploaded."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v2/ensembles/{ensembleId}/files"},{"label":"Create ensemble files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-ensembles/ensembles-v2-experimental/postv2ensemblefiles","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-ensembles/ensembles-v2-experimental/postv2ensemblefiles","metadata":{"seo":{"title":"Create ensemble files","description":"Create ensemble file placeholders and return signed URLs for the file uploads.File names are case-sensitive - so foo and Foo are 2 different files.If a file already exists a new signed URL will be returned."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v2/ensembles/{ensembleId}/files"}]}],"metadata":{"type":"openapi","title":"Ensembles Service","version":"1.0.0","description":"The Ensembles API is responsible for managing the grouping of realizations into ensembles.\n {% admonition type=\"warning\" name=\"\" %}\n Restricted Access ! \n\n Existing customer can request access via [Customer Support for Digital](https://customersupport.digital.slb.com/).\n\n Automatic population of the API Key and S‑Auth token is not supported in the “Try It” interface for this API.\n{% /admonition %}\n```plain {% title=\"Client ID\" %}\ndigitalresvc-digitalre.slbservice.com\n```\n\n## Key concepts\n* **Ensemble**: An ensemble consists of a set of realizations. Ensembles are treated as atomic first class entities. Each ensemble\n - has a unique ID\n - is immutable\n - is associated with a single branch in simulations service, and is uniquely named inside the branch\n\n The ensemble ID can be discovered in the Reservoir Engineering Workspace web app\n\n* **Realization**: A realization is a simulation in an ensemble together with its associated data. Each realization has:\n - a simulation ID corresponding to a simulation in simulations service\n - a set of parameters, possibly of length 0\n\n All realizations of an ensemble are associated with simulations that belong to a single branch in simulations service, and hence a single collection in simulations service\n\n* **Parameter**: Parameters describe what values were used upstream to generate simulation inputs. Petrel's Uncertainty and Optimization process is an example of this.\n\n Parameters do not have units, and they are a copy of the simulation parameters in simulations service.\n\n* **Simulations Service**: API for managing files that consitute simulation models\n"}},{"type":"group","fsPath":"solutions/reservoir-engineering/apis/reservoir-engineering-jobs.yaml","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs","label":"Jobs","items":[{"type":"link","label":"ARM API Usage","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/section/arm-api-usage","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/section/arm-api-usage"},{"type":"group","label":"arm-v1-experimental","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/arm-v1-experimental","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/arm-v1-experimental","items":[{"label":"Create an ARM session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/arm-v1-experimental/postv1armsessions","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/arm-v1-experimental/postv1armsessions","metadata":{"seo":{"title":"Create an ARM session","description":"Create an ARM session to facilitate running and monitoring the ARM workflow. The session will be deleted if it is idle for 1 hour."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v1/arm/sessions"},{"label":"Delete an ARM session","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/arm-v1-experimental/deletev1armsession","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/arm-v1-experimental/deletev1armsession","metadata":{"seo":{"title":"Delete an ARM session","description":"Delete an existing ARM session by Id."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v1/arm/sessions/{sessionId}"},{"label":"Create a new ensemble for the ARM workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/arm-v1-experimental/postv1armensembles","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/arm-v1-experimental/postv1armensembles","metadata":{"seo":{"title":"Create a new ensemble for the ARM workflow","description":"Create a new ensemble and a new collection to hold it. This endpoint returns the new ensemble Id and collection Id."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v1/arm/ensembles"},{"label":"Run the ARM workflow and populate an ensemble.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/arm-v1-experimental/postv1armensemblejobs","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/arm-v1-experimental/postv1armensemblejobs","metadata":{"seo":{"title":"Run the ARM workflow and populate an ensemble.","description":"Executes the ARM workflow to populate an ensemble"}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v1/arm/ensembles/jobs"},{"label":"Validate ARM job parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/arm-v1-experimental/postv1armjobvalidation","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/arm-v1-experimental/postv1armjobvalidation","metadata":{"seo":{"title":"Validate ARM job parameters","description":"Validates the ARM job parameters including aspects of the Petrel U&O workflow and conformity with the required scale limits."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v1/arm/job-validation"}]},{"type":"group","label":"Simulations","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/simulations","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/simulations","items":[{"label":"Run a simulation and upload results","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/simulations/postv1alphasimulationruns","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/simulations/postv1alphasimulationruns","metadata":{"seo":{"title":"Run a simulation and upload results","description":"Trigger a simulation run and upload results. Uses a simulation from the Simulations Service as input, runs it, and uploads the result back to the Simulations Service."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v1-alpha/simulations/runs"},{"label":"Get the status of a simulation run.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/simulations/getv1alphasimulationrun","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/simulations/getv1alphasimulationrun","metadata":{"seo":{"title":"Get the status of a simulation run.","description":"Returns the status of the simulation run."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v1-alpha/simulations/runs/{simulationRunId}"}]},{"type":"group","label":"Schemas","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/schemas","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/schemas","items":[{"type":"link","label":"Ulid","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/schemas/ulid","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-jobs/schemas/ulid","httpVerb":"schema"}]}],"metadata":{"type":"openapi","title":"Jobs Service","version":"1.0.0","description":"{% admonition type=\"warning\" name=\"\" %}\n\tRestricted Access !\n\n\tExisting customer can request access via [Customer Support for Digital](https://customersupport.digital.slb.com/).\n\n\tAutomatic population of the API Key and S‑Auth token is not supported in the “Try It” interface for this API.\n{% /admonition %}\n```plain {% title=\"Client ID\" %}\ndigitalresvc-digitalre.slbservice.com\n```\n\n## ARM API Usage\n\nCentral to the ARM process is the *samples* csv file. The samples file specifies the values\nof the Petrel U&O parameters for each realization. A sample file for 4 realizations,\nspecifying the `$PERM` and `$PORO` uncertainty variables would look like:\n\n```\nRUN, CASE, $PERM, $PORO\n1, HM_ENSEMBLE_IXDS_1, 100, 0.1\n2, HM_ENSEMBLE_IXDS_2, 200, 0.15\n3, HM_ENSEMBLE_IXDS_3, 300, 0.2\n4, HM_ENSEMBLE_IXDS_4, 400, 0.25\n```\nThe `RUN` and `CASE` columns are always required. The RUN column gives the run number of the\nrealization and should be an index increment from 1. The CASE column specifies the name of\nthe case that will be exported by Petrel. The case names need to be unique within the sample\nfile and in addition unique within the Petrel project. One way to way to help ensure uniqueness\nis to start the case name with the ensemble name.\n\nTo run ARM via API:\n1. Create and validate your U&O workflow in Petrel.\n1. Ensure the Petrel project is saved to Petrel Explorer and then export the U&O metadata.\n1. Call the `/v1/arm/job-validation` including the exported petrel U&O Metadata. If\n the validation fails modify the target number of realizations or adjust the U&O workflow,\n re-save the project and re-export the metadata.\n1. Create a new ARM session with the endpoint `POST /v1/arm/sessions`.\n1. Using the EESy tooling create a filestore, for example `samples-data` and copy your `samples.csv` files to the filestore, for example\n using the EESy CLI:\n ```\n eesy files cp samples.csv es://samples-data/samples.csv\n ```\n1. Create a new ensemble with the endpoint `POST /v1/arm/ensembles`.\n1. Run the ARM job using the endpoint `POST /v1/arm/ensembles/jobs`, specifying the location of the samples file,\n for example `es://samples-data/samples.csv`.\n1. Once running the ARM job will appear in the Reservoir Simulation Monitoring Tool, and the ensemble\n will be present in RE Workspace.\n1. Once the ARM job has completed the ARM session can be deleted with the `DELETE /v1/arm/sessions/{sessionId}`\n endpoint.\n\n","summary":"Jobs Service is responsible for initiating compute-intensive reservoir engineering processes including e.g. ARM."}},{"type":"group","fsPath":"solutions/reservoir-engineering/apis/reservoir-engineering-simulations.yaml","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations","label":"Simulations","items":[{"type":"link","label":"Key Concepts","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/section/key-concepts","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/section/key-concepts"},{"type":"link","label":"Simulation Import","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/section/simulation-import","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/section/simulation-import"},{"type":"link","label":"File paths","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/section/file-paths","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/section/file-paths"},{"type":"group","label":"Collections","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/collections","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/collections","items":[{"label":"Create a new collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/collections/postv2alphacollections","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/collections/postv2alphacollections","metadata":{"seo":{"title":"Create a new collection","description":"Creates a collection. A collection is a namespace for files in simulation models. Before importing simulations, you must first create a collection to contain the simulation files."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v2-alpha/collections"},{"label":"Get a collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/collections/getv2alphacollection","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/collections/getv2alphacollection","metadata":{"seo":{"title":"Get a collection","description":"Retrieves a collection by its ID."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v2-alpha/collections/{collectionId}"}]},{"type":"group","label":"Simulations","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/simulations","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/simulations","items":[{"label":"Create a simulation import","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/simulations/postv2alphasimulationimports","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/simulations/postv2alphasimulationimports","metadata":{"seo":{"title":"Create a simulation import","description":"Initiates a simulation import and returns pre-signed URLs for file upload"}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v2-alpha/simulation-imports"},{"label":"Get a simulation import","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/simulations/getv2alphasimulationimport","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/simulations/getv2alphasimulationimport","metadata":{"seo":{"title":"Get a simulation import","description":"Retrieves the status of a simulation import operation."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v2-alpha/simulation-imports/{importId}"},{"label":"Create a simulation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/simulations/postv2alphasimulationimportscomplete","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/simulations/postv2alphasimulationimportscomplete","metadata":{"seo":{"title":"Create a simulation","description":"Triggers asynchronous import of uploaded files to create a new simulation. Each importId can be submitted only once."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v2-alpha/simulation-imports/{importId}/complete"},{"label":"Get a simulation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/simulations/getv2alphasimulation","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/simulations/getv2alphasimulation","metadata":{"seo":{"title":"Get a simulation","description":"Retrieves a simulation by its ID."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v2-alpha/simulations/{simulationId}"},{"label":"List simulation files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/simulations/getv2alphasimulationfiles","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/simulations/getv2alphasimulationfiles","metadata":{"seo":{"title":"List simulation files","description":"Returns input and/or output files for a simulation."}},"badges":[{"name":"Alpha","color":"#8152CA","position":"after"}],"httpPath":"/v2-alpha/simulations/{simulationId}/files"}]},{"type":"group","label":"Schemas","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/schemas","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/schemas","items":[{"type":"link","label":"DownloadUrl","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/schemas/downloadurl","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/schemas/downloadurl","httpVerb":"schema"},{"type":"link","label":"EntitlementGroup","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/schemas/entitlementgroup","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/schemas/entitlementgroup","httpVerb":"schema"},{"type":"link","label":"SimulationFile","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/schemas/simulationfile","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/schemas/simulationfile","httpVerb":"schema"},{"type":"link","label":"Ulid","link":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/schemas/ulid","routeSlug":"/solutions/reservoir-engineering/apis/reservoir-engineering-simulations/schemas/ulid","httpVerb":"schema"}]}],"metadata":{"type":"openapi","title":"Simulations Service","version":"1.0.0","description":"{% admonition type=\"warning\" name=\"\" %}\n\tRestricted Access !\n\n\tExisting customer can request access via [Customer Support for Digital](https://customersupport.digital.slb.com/).\n\n\tAutomatic population of the API Key and S‑Auth token is not supported in the “Try It” interface for this API.\n{% /admonition %}\n```plain {% title=\"Client ID\" %}\ndigitalresvc-digitalre.slbservice.com\n```\n\n## Key Concepts\n- File: An immutable resource that is identified by its path within a collection.\n- Collection: A namespace for files that enables file sharing. Collections are portable in the sense that they can\n be sync'ed by different clients with the relative location of the files intact.\n- Simulation: The set of input and output files in a collection comprising a simulation model.\n\n## Simulation Import\nThe typical simulation import workflow is:\n1. Create a collection with `POST /collections`.\n2. Create a simulation import with `POST /simulation-imports`, declaring file paths for the simulation (see **File paths** below).\n3. Upload each file with a `PUT` request to its `url` from the previous step, directly against\n the cloud storage that issued it. On Azure, also set the `x-ms-blob-type` header to `blobType`.\n4. Trigger asynchronous import of the uploaded files with `POST /simulation-imports/{importId}/complete` to create the simulation. A simulation import can only be submitted once per import ID.\n5. Poll import status with `GET /simulation-imports/{importId}`.\n\n### File paths\n\nA `FilePath` is the path of a file relative to the import root directory for the import\nworkflow on the selected collection. On download, each file is written to\n`