ComboCurve.Api.Api.AriesForecastApi

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

Method	HTTP request	Description
GetAriesForecast	GET /v1/projects/{projectId}/forecasts/{forecastId}/aries	Returns a list of aries forecast scoped to projectId project and forecastId forecast.
HeadAriesForecast	HEAD /v1/projects/{projectId}/forecasts/{forecastId}/aries	Returns metadata about the aries forecast documents scoped to projectId project and forecastId forecast.

GetAriesForecast

ICollection<AriesForecast> GetAriesForecast (string projectId, string forecastId, int? skip = null, int? take = null, string sort = null, string cursor = null, string well = null, string pSeries = null, DateTimeOffset? startDate = null, string selectedIdKey = null, string endingCondition = null, string forecastUnit = null, string toLife = null, string dataResolution = null, bool? includeZeroForecast = null, bool? forecastStartToLatestProd = null, bool? forecastHistoryMatch = null)

Returns a list of aries forecast scoped to projectId project and forecastId forecast.

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 GetAriesForecastExample
    {
        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);

			// Or use the specific API class (Recommended)
			// var apiInstance = new AriesForecastApi(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var forecastId = "forecastId_example";  // string | 
            var skip = 56;  // int? | number of items to skip (optional) (default to 0)
            var take = 56;  // int? | max records to return (optional) (default to 25) (between 1 and 200)
            var sort = "sort_example";  // string | field to sort by, including + or - at the beginning for ascending or descending order, respectively (optional)
            var cursor = "cursor_example";  // string | used in pagination to get the next page (optional)
            var well = "well_example";  // string | filter by well (optional)
            var pSeries = "pSeries_example";  // string | filter by pSeries (optional) (default to best)
            var startDate = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by startDate, can be used for incremental pull (optional)
            var selectedIdKey = "selectedIdKey_example";  // string | filter by selectedIdKey (optional) (default to chosenID)
            var endingCondition = "endingCondition_example";  // string | filter by endingCondition (optional) (default to years)
            var forecastUnit = "forecastUnit_example";  // string | filter by forecastUnit (optional) (default to per_day)
            var toLife = "toLife_example";  // string | filter by toLife (optional) (default to no)
            var dataResolution = "dataResolution_example";  // string | filter by dataResolution (optional) (default to same_as_forecast)
            var includeZeroForecast = true;  // bool? | filter by includeZeroForecast (optional)
            var forecastStartToLatestProd = true;  // bool? | filter by forecastStartToLatestProd (optional)
            var forecastHistoryMatch = true;  // bool? | filter by forecastHistoryMatch (optional)

            try
            {
                // Returns a list of aries forecast scoped to projectId project and forecastId forecast.
                ICollection<AriesForecast> result = apiInstance.GetAriesForecast(projectId, forecastId, skip, take, sort, cursor, well, pSeries, startDate, selectedIdKey, endingCondition, forecastUnit, toLife, dataResolution, includeZeroForecast, forecastStartToLatestProd, forecastHistoryMatch);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AriesForecastApi.GetAriesForecast: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
projectId	string
forecastId	string
skip	int?	number of items to skip	[optional] [default to 0]
take	int?	max records to return	[optional] [default to 25] [between 1 and 200]
sort	string	field to sort by, including + or - at the beginning for ascending or descending order, respectively	[optional]
cursor	string	used in pagination to get the next page	[optional]
well	string	filter by well	[optional]
pSeries	string	filter by pSeries	[optional] [default to best]
startDate	DateTimeOffset?	filter by startDate, can be used for incremental pull	[optional]
selectedIdKey	string	filter by selectedIdKey	[optional] [default to chosenID]
endingCondition	string	filter by endingCondition	[optional] [default to years]
forecastUnit	string	filter by forecastUnit	[optional] [default to per_day]
toLife	string	filter by toLife	[optional] [default to no]
dataResolution	string	filter by dataResolution	[optional] [default to same_as_forecast]
includeZeroForecast	bool?	filter by includeZeroForecast	[optional]
forecastStartToLatestProd	bool?	filter by forecastStartToLatestProd	[optional]
forecastHistoryMatch	bool?	filter by forecastHistoryMatch	[optional]

Return type

ICollection<AriesForecast>

Authorization

API Key, Service Account

HTTP request headers

Content-Type: Not defined
Accept: application/json

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]

HeadAriesForecast

void HeadAriesForecast (string projectId, string forecastId, int? skip = null, int? take = null, string well = null)

Returns metadata about the aries forecast documents scoped to projectId project and forecastId forecast.