Introduction to Company Level Econ Models

Important: Economic models that use Data Snaps can not be returned via the API. For more information on Data Snaps, please see the ComboCurve knowledge base or contact your Customer Success representative.

To use the Econ Models in the REST API you should first understand the following:

• All econ-models in the API allow HEAD, PUT, POST, GET, and DELETE operations.
• To create a new econ-model, the API always requires the "name" and "unique" properties to be present.
• In regards to Econ Models "name" must be unique but it is also case sensitive. So you can have two different models with the same name using a different case. Ex: Test Model and Test model .
• "unique" property should be set to "true" if the econ-model is unique to a specific well.
  • If the "unique" property is set to "true", then the "well" and  "scenario" properties are also required.
• "unique" property should be set to "false" if the econ-model is not unique a specific well.
  • If the "unique" property is set to "false", then the "well" and "scenario" properties cannot be present.

With this understanding, here is an example of how you can use the schema to consume the API:

1. To create a new econ-model object:

• Make a POST request to the API endpoint with the following JSON data:

    {
      "name": "Test POST Unique Model",
      "unique": true,
      "scenario": "62fbcded61372e001314f8c1",
      "well": "630ce0230bfe400013f041f1"
      <econModelType>: {
      	//Here you would define the type of econ model you want to create
      }
    }

• Make sure to replace <econModelType> with the actual econ model you will be using. For reference please visit the corresponding section of the documentation related to your model of choice.

2. To update an existing econ-model object:

• Make a PUT request to the API endpoint with the following JSON data:

    {
      "name": "Test PUT Non-Unique Model",
      "unique": true,
      "scenario": "62gcdfsd61547df369714f8b3",
      "well": "62fbcded61372e001314f8c1"
      <econModelType>: {
      	//Here you would define the type of econ model you want to create
      }
    }

• Make sure to replace <econModelType> with the actual econ-model you will be using. For reference please visit the corresponding section of the documentation related to your model of choice.

NOTE: When you make a PUT request the API will match on the name property which is case sensitive. If there is a match then whatever data is sent in the request will overwrite what previously existed for that model. So in order to update a model you will need to include all preexisting fields/values and only modify the field(s) and value(s) that you want to change. If there is no match on  the name property then a PUT request will create a new model with the name you defined.

3. To retrieve an existing econ-model objects:

• You can make a GET by ID request to the API endpoint with the ID of the object you want to retrieve from the project.
• You can make a GET request to the API endpoint which will return all of the econ-models in the project.

4. To delete an existing econ-model object:

• Make a DELETE request to the API endpoint with the ID of the object you want to delete in the project.