Econ Models API Reference
This document provides a detailed overview of the various economic model types available in the API and how to work with them.
Valid Econ Model Types
The following table lists all valid values for the econName parameter that can be used in API endpoints:
| API Path Parameter | Description |
|---|---|
capex | Capital Expenditure models |
date-settings | Date settings for economic models (also accepts date_settings and dates) |
differentials | Differential price adjustments |
emissions | Emission models |
expenses | Operating expense models |
fluid-models | Fluid models (also accepts fluidModel and fluid_models) |
general-options | General economic model options (also accepts generaloptions and general_options) |
ownership-reversions | Ownership and reversion models (also accepts ownershipreversion, ownershipandreversion, and ownership_reversions) |
pricing | Commodity pricing models |
production-taxes | Production tax models (also accepts productiontaxes and production_taxes) |
actual-forecast | Actual vs forecast production data (also accepts actualforecast, actualorforecast, and actual_forecast) |
reserves-categories | Reserves category classifications (also accepts reserves, reservescategory, and reserves_categories) |
riskings | Risk adjustment models (also accepts risking) |
stream-properties | Stream property definitions (also accepts streamproperties and stream_properties) |
URL Parameters
When working with Econ Models Assignments endpoints, the following URL parameters are typically required:
Path Parameters
| Parameter | Description | Required |
|---|---|---|
projectId | The ID of the project containing the economic models | Yes |
econName | The type of economic model (from the table above) | Yes |
econModelId | The specific ID of the economic model | Yes |
Query Parameters for Assignments
When working with assignments, these additional parameters may be used:
| Parameter | Description | Required |
|---|---|---|
wells | IDs of wells to include (can specify multiple) | No |
scenarios | IDs of scenarios to include (can specify multiple) | No |
scenarioId | Specific scenario ID (for deletion operations) | Yes (for DELETE) |
qualifierName | Name of qualifier | No |
allWells | Whether to include all wells | No |
skip | Number of items to skip (pagination) | No |
take | Max records to return (pagination) | No |
sort | Field to sort by (with + or - for direction) | No |
Example Usage
Economic models can be assigned to wells and scenarios. The endpoint for managing these assignments is:
/v1/projects/{projectId}/econ-models/{econName}/{econModelId}/assignments
This endpoint supports:
GET: Retrieve assignmentsPOST/PUT: Create or update assignmentsDELETE: Remove assignments
NOTE: When making API requests, ensure you use the path parameter formats shown in the table above. The API accepts various formats for some parameters to provide flexibility.