combocurve-client-csharp

Logo

C# client for the ComboCurve REST API

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

ComboCurve.Api.Api.EmbeddedLookupTablesApi

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

Method HTTP request Description
DeleteCompanyEmbeddedLookupTableById DELETE /v1/embedded-lookup-tables/{id} Deletes the embedded lookup table document that matches the given id. It also removes the links to it from the econ models.
DeleteEmbeddedLookupTableById DELETE /v1/projects/{projectId}/embedded-lookup-tables/{id} Deletes the embedded lookup table document that matches the given id. It also removes the links to it from the econ models.
GetCompanyEmbeddedLookupTableById GET /v1/embedded-lookup-tables/{id} Returns the embedded lookup table document that matches the given id.
GetCompanyEmbeddedLookupTables GET /v1/embedded-lookup-tables Returns a list of company embedded lookup table documents.
GetEmbeddedLookupTableById GET /v1/projects/{projectId}/embedded-lookup-tables/{id} Returns the embedded lookup table document that matches the given id.
GetEmbeddedLookupTables GET /v1/projects/{projectId}/embedded-lookup-tables Returns a list of embedded lookup table documents of the project.
HeadCompanyEmbeddedLookupTables HEAD /v1/embedded-lookup-tables Returns metadata about the existing company embedded lookup table documents.
HeadEmbeddedLookupTables HEAD /v1/projects/{projectId}/embedded-lookup-tables Returns metadata about the existing embedded lookup table documents of the project.
PostCompanyEmbeddedLookupTables POST /v1/embedded-lookup-tables Inserts a list of company embedded lookup table documents. A name must be unique at the company level for all types.
PostEmbeddedLookupTables POST /v1/projects/{projectId}/embedded-lookup-tables Inserts a list of project embedded lookup table documents. A name must be unique at the project level for all types.
PutCompanyEmbeddedLookupTables PUT /v1/embedded-lookup-tables Replaces or creates a list of company embedded lookup table documents, by name. A replace changes all rows, rules and options, and keeps `createdBy`, `copiedFrom` and `tags`. A replace cannot change the type.
PutEmbeddedLookupTables PUT /v1/projects/{projectId}/embedded-lookup-tables Replaces or creates a list of project embedded lookup table documents, by name. A replace changes all rows, rules and options, and keeps `createdBy`, `copiedFrom` and `tags`. A replace cannot change the type.

DeleteCompanyEmbeddedLookupTableById

void DeleteCompanyEmbeddedLookupTableById (string id)

Deletes the embedded lookup table document that matches the given id. It also removes the links to it from the econ models.

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 DeleteCompanyEmbeddedLookupTableByIdExample
    {
        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 EmbeddedLookupTablesApi(serviceAccount, apiKey);

            var id = "id_example";  // string | 

            try
            {
                // Deletes the embedded lookup table document that matches the given id. It also removes the links to it from the econ models.
                apiInstance.DeleteCompanyEmbeddedLookupTableById(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmbeddedLookupTablesApi.DeleteCompanyEmbeddedLookupTableById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string    

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 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]

DeleteEmbeddedLookupTableById

void DeleteEmbeddedLookupTableById (string projectId, string id)

Deletes the embedded lookup table document that matches the given id. It also removes the links to it from the econ models.

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 DeleteEmbeddedLookupTableByIdExample
    {
        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 EmbeddedLookupTablesApi(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var id = "id_example";  // string | 

            try
            {
                // Deletes the embedded lookup table document that matches the given id. It also removes the links to it from the econ models.
                apiInstance.DeleteEmbeddedLookupTableById(projectId, id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmbeddedLookupTablesApi.DeleteEmbeddedLookupTableById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
id string    

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 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]

GetCompanyEmbeddedLookupTableById

EmbeddedLookupTable GetCompanyEmbeddedLookupTableById (string id)

Returns the embedded lookup table document that matches the given id.

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 GetCompanyEmbeddedLookupTableByIdExample
    {
        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 EmbeddedLookupTablesApi(serviceAccount, apiKey);

            var id = "id_example";  // string | 

            try
            {
                // Returns the embedded lookup table document that matches the given id.
                EmbeddedLookupTable result = apiInstance.GetCompanyEmbeddedLookupTableById(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmbeddedLookupTablesApi.GetCompanyEmbeddedLookupTableById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
id string    

Return type

EmbeddedLookupTable

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. | - | | 404 | Not Found | - |

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

GetCompanyEmbeddedLookupTables

ICollection<EmbeddedLookupTable> GetCompanyEmbeddedLookupTables (int? skip = null, int? take = null, string sort = null, string cursor = null, DateTimeOffset? createdAt = null, string name = null, string type = null, DateTimeOffset? updatedAt = null)

Returns a list of company embedded lookup table documents.

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 GetCompanyEmbeddedLookupTablesExample
    {
        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 EmbeddedLookupTablesApi(serviceAccount, apiKey);

            var skip = 56;  // int? | number of items to skip (optional) (default to 0)
            var take = 56;  // int? | max records to return (optional) (default to 10) (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 createdAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z (optional)
            var name = "name_example";  // string | filter by name (optional)
            var type = "type_example";  // string | filter by type. Without this filter, the list has all the types that the tenant can use. (optional)
            var updatedAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z (optional)

            try
            {
                // Returns a list of company embedded lookup table documents.
                ICollection<EmbeddedLookupTable> result = apiInstance.GetCompanyEmbeddedLookupTables(skip, take, sort, cursor, createdAt, name, type, updatedAt);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmbeddedLookupTablesApi.GetCompanyEmbeddedLookupTables: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
skip int? number of items to skip [optional] [default to 0]
take int? max records to return [optional] [default to 10] [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]
createdAt DateTimeOffset? filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z [optional]
name string filter by name [optional]
type string filter by type. Without this filter, the list has all the types that the tenant can use. [optional]
updatedAt DateTimeOffset? filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z [optional]

Return type

ICollection<EmbeddedLookupTable>

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK | * 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 | Bad Request. There is something wrong with the request data. | - |

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

GetEmbeddedLookupTableById

EmbeddedLookupTable GetEmbeddedLookupTableById (string projectId, string id)

Returns the embedded lookup table document that matches the given id.

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 GetEmbeddedLookupTableByIdExample
    {
        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 EmbeddedLookupTablesApi(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var id = "id_example";  // string | 

            try
            {
                // Returns the embedded lookup table document that matches the given id.
                EmbeddedLookupTable result = apiInstance.GetEmbeddedLookupTableById(projectId, id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmbeddedLookupTablesApi.GetEmbeddedLookupTableById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
id string    

Return type

EmbeddedLookupTable

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. | - | | 404 | Not Found | - |

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

GetEmbeddedLookupTables

ICollection<EmbeddedLookupTable> GetEmbeddedLookupTables (string projectId, int? skip = null, int? take = null, string sort = null, string cursor = null, DateTimeOffset? createdAt = null, string name = null, string type = null, DateTimeOffset? updatedAt = null)

Returns a list of embedded lookup table documents of the project.

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 GetEmbeddedLookupTablesExample
    {
        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 EmbeddedLookupTablesApi(serviceAccount, apiKey);

            var projectId = "projectId_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 10) (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 createdAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z (optional)
            var name = "name_example";  // string | filter by name (optional)
            var type = "type_example";  // string | filter by type. Without this filter, the list has all the types that the tenant can use. (optional)
            var updatedAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z (optional)

            try
            {
                // Returns a list of embedded lookup table documents of the project.
                ICollection<EmbeddedLookupTable> result = apiInstance.GetEmbeddedLookupTables(projectId, skip, take, sort, cursor, createdAt, name, type, updatedAt);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmbeddedLookupTablesApi.GetEmbeddedLookupTables: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
skip int? number of items to skip [optional] [default to 0]
take int? max records to return [optional] [default to 10] [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]
createdAt DateTimeOffset? filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z [optional]
name string filter by name [optional]
type string filter by type. Without this filter, the list has all the types that the tenant can use. [optional]
updatedAt DateTimeOffset? filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z [optional]

Return type

ICollection<EmbeddedLookupTable>

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 200 | OK | * 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 | Bad Request. There is something wrong with the request data. | - |

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

HeadCompanyEmbeddedLookupTables

void HeadCompanyEmbeddedLookupTables (int? skip = null, int? take = null, DateTimeOffset? createdAt = null, string name = null, string type = null, DateTimeOffset? updatedAt = null)

Returns metadata about the existing company embedded lookup table documents.

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 HeadCompanyEmbeddedLookupTablesExample
    {
        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 EmbeddedLookupTablesApi(serviceAccount, apiKey);

            var skip = 56;  // int? | number of items to skip (optional) (default to 0)
            var take = 56;  // int? | max records to return (optional) (default to 10) (between 1 and 200)
            var createdAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z (optional)
            var name = "name_example";  // string | filter by name (optional)
            var type = "type_example";  // string | filter by type. Without this filter, the list has all the types that the tenant can use. (optional)
            var updatedAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z (optional)

            try
            {
                // Returns metadata about the existing company embedded lookup table documents.
                apiInstance.HeadCompanyEmbeddedLookupTables(skip, take, createdAt, name, type, updatedAt);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmbeddedLookupTablesApi.HeadCompanyEmbeddedLookupTables: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
skip int? number of items to skip [optional] [default to 0]
take int? max records to return [optional] [default to 10] [between 1 and 200]
createdAt DateTimeOffset? filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z [optional]
name string filter by name [optional]
type string filter by type. Without this filter, the list has all the types that the tenant can use. [optional]
updatedAt DateTimeOffset? filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z [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 | * X-Query-Count - The number of records in this resource. When filters are provided only matching records are counted.
* 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 | Bad Request. There is something wrong with the request data. | - |

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

HeadEmbeddedLookupTables

void HeadEmbeddedLookupTables (string projectId, int? skip = null, int? take = null, DateTimeOffset? createdAt = null, string name = null, string type = null, DateTimeOffset? updatedAt = null)

Returns metadata about the existing embedded lookup table documents of the project.

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 HeadEmbeddedLookupTablesExample
    {
        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 EmbeddedLookupTablesApi(serviceAccount, apiKey);

            var projectId = "projectId_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 10) (between 1 and 200)
            var createdAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z (optional)
            var name = "name_example";  // string | filter by name (optional)
            var type = "type_example";  // string | filter by type. Without this filter, the list has all the types that the tenant can use. (optional)
            var updatedAt = DateTimeOffset.Parse("2013-10-20");  // DateTimeOffset? | filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z (optional)

            try
            {
                // Returns metadata about the existing embedded lookup table documents of the project.
                apiInstance.HeadEmbeddedLookupTables(projectId, skip, take, createdAt, name, type, updatedAt);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmbeddedLookupTablesApi.HeadEmbeddedLookupTables: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
skip int? number of items to skip [optional] [default to 0]
take int? max records to return [optional] [default to 10] [between 1 and 200]
createdAt DateTimeOffset? filter by createdAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example createdAt[gt]=2018-01-01T00:00:00Z [optional]
name string filter by name [optional]
type string filter by type. Without this filter, the list has all the types that the tenant can use. [optional]
updatedAt DateTimeOffset? filter by updatedAt - Operator values are [lt] = less than, [le] = less than or equal, [gt] = greater than, [ge] = greater than or equal, no operator = equal. Example updatedAt[gt]=2018-01-01T00:00:00Z [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 | * X-Query-Count - The number of records in this resource. When filters are provided only matching records are counted.
* 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 | Bad Request. There is something wrong with the request data. | - |

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

PostCompanyEmbeddedLookupTables

EmbeddedLookupTableMultiStatusResponse PostCompanyEmbeddedLookupTables (List embeddedLookupTables = null)

Inserts a list of company embedded lookup table documents. A name must be unique at the company level for all types.

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 PostCompanyEmbeddedLookupTablesExample
    {
        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 EmbeddedLookupTablesApi(serviceAccount, apiKey);

            var embeddedLookupTables = new List<EmbeddedLookupTable>(); // List<EmbeddedLookupTable> | Embedded lookup table document(s) to insert. (optional) 

            try
            {
                // Inserts a list of company embedded lookup table documents. A name must be unique at the company level for all types. 
                EmbeddedLookupTableMultiStatusResponse result = apiInstance.PostCompanyEmbeddedLookupTables(embeddedLookupTables);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmbeddedLookupTablesApi.PostCompanyEmbeddedLookupTables: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
embeddedLookupTables List<EmbeddedLookupTable> Embedded lookup table document(s) to insert. [optional] [Max number of items is 50]

Return type

EmbeddedLookupTableMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | Multi-Status | - | | 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]

PostEmbeddedLookupTables

EmbeddedLookupTableMultiStatusResponse PostEmbeddedLookupTables (string projectId, List embeddedLookupTables = null)

Inserts a list of project embedded lookup table documents. A name must be unique at the project level for all types.

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 PostEmbeddedLookupTablesExample
    {
        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 EmbeddedLookupTablesApi(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var embeddedLookupTables = new List<EmbeddedLookupTable>(); // List<EmbeddedLookupTable> | Embedded lookup table document(s) to insert. (optional) 

            try
            {
                // Inserts a list of project embedded lookup table documents. A name must be unique at the project level for all types. 
                EmbeddedLookupTableMultiStatusResponse result = apiInstance.PostEmbeddedLookupTables(projectId, embeddedLookupTables);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmbeddedLookupTablesApi.PostEmbeddedLookupTables: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
embeddedLookupTables List<EmbeddedLookupTable> Embedded lookup table document(s) to insert. [optional] [Max number of items is 50]

Return type

EmbeddedLookupTableMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | Multi-Status | - | | 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]

PutCompanyEmbeddedLookupTables

EmbeddedLookupTableMultiStatusResponse PutCompanyEmbeddedLookupTables (List embeddedLookupTables = null)

Replaces or creates a list of company embedded lookup table documents, by name. A replace changes all rows, rules and options, and keeps createdBy, copiedFrom and tags. A replace cannot change the type.

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 PutCompanyEmbeddedLookupTablesExample
    {
        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 EmbeddedLookupTablesApi(serviceAccount, apiKey);

            var embeddedLookupTables = new List<EmbeddedLookupTable>(); // List<EmbeddedLookupTable> | Embedded lookup table document(s) to replace or create. (optional) 

            try
            {
                // Replaces or creates a list of company embedded lookup table documents, by name. A replace changes all rows, rules and options, and keeps `createdBy`, `copiedFrom` and `tags`. A replace cannot change the type. 
                EmbeddedLookupTableMultiStatusResponse result = apiInstance.PutCompanyEmbeddedLookupTables(embeddedLookupTables);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmbeddedLookupTablesApi.PutCompanyEmbeddedLookupTables: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
embeddedLookupTables List<EmbeddedLookupTable> Embedded lookup table document(s) to replace or create. [optional] [Max number of items is 50]

Return type

EmbeddedLookupTableMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | Multi-Status | - | | 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]

PutEmbeddedLookupTables

EmbeddedLookupTableMultiStatusResponse PutEmbeddedLookupTables (string projectId, List embeddedLookupTables = null)

Replaces or creates a list of project embedded lookup table documents, by name. A replace changes all rows, rules and options, and keeps createdBy, copiedFrom and tags. A replace cannot change the type.

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 PutEmbeddedLookupTablesExample
    {
        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 EmbeddedLookupTablesApi(serviceAccount, apiKey);

            var projectId = "projectId_example";  // string | 
            var embeddedLookupTables = new List<EmbeddedLookupTable>(); // List<EmbeddedLookupTable> | Embedded lookup table document(s) to replace or create. (optional) 

            try
            {
                // Replaces or creates a list of project embedded lookup table documents, by name. A replace changes all rows, rules and options, and keeps `createdBy`, `copiedFrom` and `tags`. A replace cannot change the type. 
                EmbeddedLookupTableMultiStatusResponse result = apiInstance.PutEmbeddedLookupTables(projectId, embeddedLookupTables);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling EmbeddedLookupTablesApi.PutEmbeddedLookupTables: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
projectId string    
embeddedLookupTables List<EmbeddedLookupTable> Embedded lookup table document(s) to replace or create. [optional] [Max number of items is 50]

Return type

EmbeddedLookupTableMultiStatusResponse

Authorization

API Key, Service Account

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| | 207 | Multi-Status | - | | 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]