combocurve-client-csharp

Logo

C# client for the ComboCurve REST API

View the Project on GitHub insidepetroleum/combocurve-client-csharp

ComboCurve.Api.Api.ComboCurveV1Api

All URIs are relative to https://api.combocurve.com

Method HTTP request Description
DeleteEconModelAssignmentDelete DELETE /v1/projects/{projectId}/econ-models/{econName}/{econModelId}/assignments  
DeleteProjectDailyProductions DELETE /v1/projects/{projectId}/daily-productions Delete the daily productions documents that match the given filters.
DeleteProjectMonthlyProductions DELETE /v1/projects/{projectId}/monthly-productions Delete the monthly productions documents that match the given filters.
DeleteProjectScenarios DELETE /v1/projects/{projectId}/scenarios  
DeleteQualifiersDelete DELETE /v1/projects/{projectId}/scenarios/{scenarioId}/qualifiers  
DeleteScenarioWellsDelete DELETE /v1/projects/{projectId}/scenarios/{scenarioId}/well-assignments  
GetEconModelsAssignmentsRead GET /v1/projects/{projectId}/econ-models/{econName}/{econModelId}/assignments  
GetOneLinersComboNames GET /v1/projects/{projectId}/scenarios/{scenarioId}/econ-runs/{econRunId}/one-liners/combo-names Returns a list of combo names contained in the one liner documents that are scoped to project, scenario and econ run.
GetQualifiersRead GET /v1/projects/{projectId}/scenarios/{scenarioId}/qualifiers  
GetScenarioWellsRead GET /v1/projects/{projectId}/scenarios/{scenarioId}/well-assignments  
HeadEconModelsAssignmentsCount HEAD /v1/projects/{projectId}/econ-models/{econName}/{econModelId}/assignments  
PostEconModelAssignmentUpsert POST /v1/projects/{projectId}/econ-models/{econName}/{econModelId}/assignments  
PostQualifiersUpsert POST /v1/projects/{projectId}/scenarios/{scenarioId}/qualifiers  
PostScenarioWellsUpsert POST /v1/projects/{projectId}/scenarios/{scenarioId}/well-assignments  
PutEconModelAssignmentUpsert PUT /v1/projects/{projectId}/econ-models/{econName}/{econModelId}/assignments  
PutQualifiersUpsert PUT /v1/projects/{projectId}/scenarios/{scenarioId}/qualifiers  
PutScenarioWellsUpsert PUT /v1/projects/{projectId}/scenarios/{scenarioId}/well-assignments  

DeleteEconModelAssignmentDelete

void DeleteEconModelAssignmentDelete (string projectId, string econName, string econModelId, string scenarioId, string qualifierName, string wells = null, bool? allWells = null)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class DeleteEconModelAssignmentDeleteExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var econName = "econName_example";  // string | 
            var econModelId = "econModelId_example";  // string | 
            var scenarioId = "scenarioId_example";  // string | 
            var qualifierName = "qualifierName_example";  // string | 
            var wells = new string[] { "wells_example" };  // IEnumerable<string> |  (optional)
            var allWells = true;  // bool? |  (optional)

            try
            {
                apiInstance.DeleteEconModelAssignmentDelete(projectId, econName, econModelId, scenarioId, qualifierName, wells, allWells);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.DeleteEconModelAssignmentDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
econName string    
econModelId string    
scenarioId string    
qualifierName string    
wells string   [optional]
allWells bool?   [optional]

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 204 | NoContent Response | * x-delete-count - | | 404 | NotFound Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteProjectDailyProductions

void DeleteProjectDailyProductions (string projectId, string well = null, string startDate = null, string endDate = null)

Delete the daily productions documents that match the given filters.

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class DeleteProjectDailyProductionsExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var well = "well_example";  // string | filter by well (optional)
            var startDate = "startDate_example";  // string | filter by startDate (optional)
            var endDate = "endDate_example";  // string | filter by endDate (optional)

            try
            {
                // Delete the daily productions documents that match the given filters.
                apiInstance.DeleteProjectDailyProductions(projectId, well, startDate, endDate);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.DeleteProjectDailyProductions: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
well string filter by well [optional]
startDate string filter by startDate [optional]
endDate string filter by endDate [optional]

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 204 | OK | * X-Delete-Count - The number of records that match the given filters and were deleted. | | 400 | Bad Request. There is something wrong with the request data. | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteProjectMonthlyProductions

void DeleteProjectMonthlyProductions (string projectId, string well = null, string startDate = null, string endDate = null)

Delete the monthly productions documents that match the given filters.

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class DeleteProjectMonthlyProductionsExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var well = "well_example";  // string | filter by well (optional)
            var startDate = "startDate_example";  // string | filter by startDate (optional)
            var endDate = "endDate_example";  // string | filter by endDate (optional)

            try
            {
                // Delete the monthly productions documents that match the given filters.
                apiInstance.DeleteProjectMonthlyProductions(projectId, well, startDate, endDate);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.DeleteProjectMonthlyProductions: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
well string filter by well [optional]
startDate string filter by startDate [optional]
endDate string filter by endDate [optional]

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 204 | OK | * X-Delete-Count - The number of records that match the given filters and were deleted. | | 400 | Bad Request. There is something wrong with the request data. | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteProjectScenarios

void DeleteProjectScenarios (string projectId, List name = null, List id = null)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class DeleteProjectScenariosExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | Project ID
            var name = new List<string>(); // List<string> | The name of the scenario to delete. If this is not provided, the id parameter must be provided. (optional) 
            var id = new List<string>(); // List<string> | The id of the scenario to delete. If this is not provided, the name parameter must be provided. (optional) 

            try
            {
                apiInstance.DeleteProjectScenarios(projectId, name, id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.DeleteProjectScenarios: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string Project ID  
name List<string> The name of the scenario to delete. If this is not provided, the id parameter must be provided. [optional] [Max number of items is 20]
id List<string> The id of the scenario to delete. If this is not provided, the name parameter must be provided. [optional]

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 204 | NoContent Response | * x-delete-count - | | 400 | BadRequest Response | - | | 404 | NotFound Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteQualifiersDelete

void DeleteQualifiersDelete (string scenarioId, string projectId, string econNames, string qualifierNames)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class DeleteQualifiersDeleteExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var scenarioId = "scenarioId_example";  // string | 
            var projectId = "projectId_example";  // string | 
            var econNames = new string[] { "econNames_example" };  // IEnumerable<string> | 
            var qualifierNames = new string[] { "qualifierNames_example" };  // IEnumerable<string> | 

            try
            {
                apiInstance.DeleteQualifiersDelete(scenarioId, projectId, econNames, qualifierNames);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.DeleteQualifiersDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
scenarioId string    
projectId string    
econNames string    
qualifierNames string    

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 204 | NoContent Response | * x-delete-count - | | 400 | BadRequest Response | - | | 404 | NotFound Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteScenarioWellsDelete

void DeleteScenarioWellsDelete (string scenarioId, string projectId, string wells)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class DeleteScenarioWellsDeleteExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var scenarioId = "scenarioId_example";  // string | 
            var projectId = "projectId_example";  // string | 
            var wells = new string[] { "wells_example" };  // IEnumerable<string> | 

            try
            {
                apiInstance.DeleteScenarioWellsDelete(scenarioId, projectId, wells);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.DeleteScenarioWellsDelete: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
scenarioId string    
projectId string    
wells string    

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 204 | NoContent Response | * x-delete-count - | | 404 | NotFound Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEconModelsAssignmentsRead

ICollection<EconModelsAssignmentsReadOKResponse> GetEconModelsAssignmentsRead (string projectId, string econName, string econModelId, int? skip = null, int? take = null, string wells = null, string scenarios = null, string sort = null)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class GetEconModelsAssignmentsReadExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var econName = "econName_example";  // string | 
            var econModelId = "econModelId_example";  // string | 
            var skip = 56;  // int? | number of items to skip (optional)
            var take = 56;  // int? | max records to return (optional) (between 1 and 200)
            var wells = new string[] { "wells_example" };  // IEnumerable<string> |  (optional)
            var scenarios = new string[] { "scenarios_example" };  // IEnumerable<string> |  (optional)
            var sort = "sort_example";  // string | field to sort by, including + or - at the beginning for ascending or descending order, respectively (optional)

            try
            {
                ICollection<EconModelsAssignmentsReadOKResponse> result = apiInstance.GetEconModelsAssignmentsRead(projectId, econName, econModelId, skip, take, wells, scenarios, sort);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.GetEconModelsAssignmentsRead: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
econName string    
econModelId string    
skip int? number of items to skip [optional]
take int? max records to return [optional] [between 1 and 200]
wells string   [optional]
scenarios string   [optional]
sort string field to sort by, including + or - at the beginning for ascending or descending order, respectively [optional]

Return type

ICollection<EconModelsAssignmentsReadOKResponse>

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK Response | * X-Query-Count -
* Link - Indicates a typed relationship with another resource, where the relation type is defined by RFC 5988. We include the relationships next, prev, first and last, which can be used to move between pages of the list of results. | | 400 | BadRequest Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOneLinersComboNames

ICollection<OneLiner> GetOneLinersComboNames (string projectId, string scenarioId, string econRunId)

Returns a list of combo names contained in the one liner documents that are scoped to project, scenario and econ run.

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class GetOneLinersComboNamesExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var scenarioId = "scenarioId_example";  // string | 
            var econRunId = "econRunId_example";  // string | 

            try
            {
                // Returns a list of combo names contained in the one liner documents that are scoped to project, scenario and econ run.
                ICollection<OneLiner> result = apiInstance.GetOneLinersComboNames(projectId, scenarioId, econRunId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.GetOneLinersComboNames: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
scenarioId string    
econRunId string    

Return type

ICollection<OneLiner>

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK | - | | 400 | Bad Request. There is something wrong with the request data. | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetQualifiersRead

QualifiersReadOKResponse GetQualifiersRead (string scenarioId, string projectId, string econName = null)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class GetQualifiersReadExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var scenarioId = "scenarioId_example";  // string | 
            var projectId = "projectId_example";  // string | 
            var econName = new string[] { "econName_example" };  // IEnumerable<string> |  (optional)

            try
            {
                QualifiersReadOKResponse result = apiInstance.GetQualifiersRead(scenarioId, projectId, econName);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.GetQualifiersRead: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
scenarioId string    
projectId string    
econName string   [optional]

Return type

QualifiersReadOKResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK Response | - | | 404 | NotFound Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetScenarioWellsRead

ScenarioWellsReadOKResponse GetScenarioWellsRead (string scenarioId, string projectId)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class GetScenarioWellsReadExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var scenarioId = "scenarioId_example";  // string | 
            var projectId = "projectId_example";  // string | 

            try
            {
                ScenarioWellsReadOKResponse result = apiInstance.GetScenarioWellsRead(scenarioId, projectId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.GetScenarioWellsRead: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
scenarioId string    
projectId string    

Return type

ScenarioWellsReadOKResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK Response | - | | 404 | NotFound Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HeadEconModelsAssignmentsCount

void HeadEconModelsAssignmentsCount (string projectId, string econName, string econModelId, string wells = null, string scenarios = null)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class HeadEconModelsAssignmentsCountExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var econName = "econName_example";  // string | 
            var econModelId = "econModelId_example";  // string | 
            var wells = new string[] { "wells_example" };  // IEnumerable<string> |  (optional)
            var scenarios = new string[] { "scenarios_example" };  // IEnumerable<string> |  (optional)

            try
            {
                apiInstance.HeadEconModelsAssignmentsCount(projectId, econName, econModelId, wells, scenarios);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.HeadEconModelsAssignmentsCount: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
econName string    
econModelId string    
wells string   [optional]
scenarios string   [optional]

Return type

void (empty response body)

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK Response | * X-Query-Count - | | 400 | BadRequest Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostEconModelAssignmentUpsert

EconModelAssignmentUpsertMultiStatusResponse PostEconModelAssignmentUpsert (string projectId, string econName, string econModelId, List payload)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class PostEconModelAssignmentUpsertExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var econName = "econName_example";  // string | 
            var econModelId = "econModelId_example";  // string | 
            var payload = new List<EconModelAssignmentUpsertPayload>(); // List<EconModelAssignmentUpsertPayload> | 

            try
            {
                EconModelAssignmentUpsertMultiStatusResponse result = apiInstance.PostEconModelAssignmentUpsert(projectId, econName, econModelId, payload);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.PostEconModelAssignmentUpsert: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
econName string    
econModelId string    
payload List<EconModelAssignmentUpsertPayload>    

Return type

EconModelAssignmentUpsertMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | MultiStatus Response | - | | 404 | NotFound Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostQualifiersUpsert

QualifiersUpsertMultiStatusResponse PostQualifiersUpsert (string scenarioId, string projectId, List payload)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class PostQualifiersUpsertExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var scenarioId = "scenarioId_example";  // string | 
            var projectId = "projectId_example";  // string | 
            var payload = new List<QualifierUpsertPayload>(); // List<QualifierUpsertPayload> | 

            try
            {
                QualifiersUpsertMultiStatusResponse result = apiInstance.PostQualifiersUpsert(scenarioId, projectId, payload);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.PostQualifiersUpsert: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
scenarioId string    
projectId string    
payload List<QualifierUpsertPayload>    

Return type

QualifiersUpsertMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | MultiStatus Response | - | | 404 | NotFound Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostScenarioWellsUpsert

ScenarioWellsUpsertMultiStatusResponse PostScenarioWellsUpsert (string scenarioId, string projectId, List wells)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class PostScenarioWellsUpsertExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var scenarioId = "scenarioId_example";  // string | 
            var projectId = "projectId_example";  // string | 
            var wells = new List<string>(); // List<string> | 

            try
            {
                ScenarioWellsUpsertMultiStatusResponse result = apiInstance.PostScenarioWellsUpsert(scenarioId, projectId, wells);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.PostScenarioWellsUpsert: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
scenarioId string    
projectId string    
wells List<string>    

Return type

ScenarioWellsUpsertMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | MultiStatus Response | - | | 400 | BadRequest Response | - | | 404 | NotFound Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutEconModelAssignmentUpsert

EconModelAssignmentUpsertMultiStatusResponse PutEconModelAssignmentUpsert (string projectId, string econName, string econModelId, List payload)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class PutEconModelAssignmentUpsertExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var econName = "econName_example";  // string | 
            var econModelId = "econModelId_example";  // string | 
            var payload = new List<EconModelAssignmentUpsertPayload>(); // List<EconModelAssignmentUpsertPayload> | 

            try
            {
                EconModelAssignmentUpsertMultiStatusResponse result = apiInstance.PutEconModelAssignmentUpsert(projectId, econName, econModelId, payload);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.PutEconModelAssignmentUpsert: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
econName string    
econModelId string    
payload List<EconModelAssignmentUpsertPayload>    

Return type

EconModelAssignmentUpsertMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | MultiStatus Response | - | | 404 | NotFound Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutQualifiersUpsert

QualifiersUpsertMultiStatusResponse PutQualifiersUpsert (string scenarioId, string projectId, List payload)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class PutQualifiersUpsertExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var scenarioId = "scenarioId_example";  // string | 
            var projectId = "projectId_example";  // string | 
            var payload = new List<QualifierUpsertPayload>(); // List<QualifierUpsertPayload> | 

            try
            {
                QualifiersUpsertMultiStatusResponse result = apiInstance.PutQualifiersUpsert(scenarioId, projectId, payload);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.PutQualifiersUpsert: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
scenarioId string    
projectId string    
payload List<QualifierUpsertPayload>    

Return type

QualifiersUpsertMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | MultiStatus Response | - | | 404 | NotFound Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PutScenarioWellsUpsert

ScenarioWellsUpsertMultiStatusResponse PutScenarioWellsUpsert (string scenarioId, string projectId, List wells)

Example

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ComboCurve.Api.Api;
using ComboCurve.Api.Auth;
using ComboCurve.Api.Client;
using ComboCurve.Api.Model;

namespace Example
{
    public class PutScenarioWellsUpsertExample
    {
        public static void Main()
        {
            // Use this to create your service account manually
            var serviceAccount = new ServiceAccount
            {
                ClientEmail = "YOUR_CLIENT_EMAIL",
                ClientId = "YOUR_CLIENT_ID",
                PrivateKey = "YOUR_PRIVATE_KEY"
            };
            // Or use this to load it from a JSON file
            // var serviceAccount = ServiceAccount.FromFile("PATH_TO_JSON_FILE");

            // Set your API key
            var apiKey = "YOUR_API_KEY";

            var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

			// You can also use the specific API class
			// var apiInstance = new ComboCurveV1Api(serviceAccount, apiKey);

            var scenarioId = "scenarioId_example";  // string | 
            var projectId = "projectId_example";  // string | 
            var wells = new List<string>(); // List<string> | 

            try
            {
                ScenarioWellsUpsertMultiStatusResponse result = apiInstance.PutScenarioWellsUpsert(scenarioId, projectId, wells);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ComboCurveV1Api.PutScenarioWellsUpsert: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
scenarioId string    
projectId string    
wells List<string>    

Return type

ScenarioWellsUpsertMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | MultiStatus Response | - | | 400 | BadRequest Response | - | | 404 | NotFound Response | - |

[Back to top] [Back to API list] [Back to Model list] [Back to README]