auto-generated-sdk

FactSet.AnalyticsAPI.Engines - the C# library for the Engines API

Allow clients to fetch Analytics through APIs.

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 2
• SDK version: 4.0.0
• Build package: CustomCSharpNetCoreClientCodegen For more information, please visit https://developer.factset.com/contact

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

Dependencies

• RestSharp - 106.10.1 or later
• Json.NET - 12.0.1 or later
• JsonSubTypes - 1.5.2 or later
• System.ComponentModel.Annotations - 4.5.0 or later
• FactSet.Protobuf.Stach - 1.1.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations
Install-Package FactSet.Protobuf.Stach

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using FactSet.AnalyticsAPI.Engines.Api;
using FactSet.AnalyticsAPI.Engines.Client;
using FactSet.AnalyticsAPI.Engines.Model;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using FactSet.AnalyticsAPI.Engines.Api;
using FactSet.AnalyticsAPI.Engines.Client;
using FactSet.AnalyticsAPI.Engines.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.factset.com";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new AccountsApi(config);
            var path = path_example;  // string | The directory to get the accounts and sub-directories in (default to "")

            try
            {
                // Get accounts and sub-directories in a directory
                AccountDirectories result = apiInstance.GetAccounts(path);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AccountsApi.GetAccounts: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccountsApi	GetAccounts	GET /analytics/lookups/v2/accounts/{path}	Get accounts and sub-directories in a directory
CalculationsApi	CancelCalculationById	DELETE /analytics/engines/v2/calculations/{id}	Cancel calculation by id
CalculationsApi	GetCalculationStatusById	GET /analytics/engines/v2/calculations/{id}	Get calculation status by id
CalculationsApi	GetCalculationStatusSummaries	GET /analytics/engines/v2/calculations	Get all calculation statuses
CalculationsApi	RunCalculation	POST /analytics/engines/v2/calculations	Run calculation
ColumnStatisticsApi	GetPAColumnStatistics	GET /analytics/lookups/v2/engines/pa/columnstatistics	Get PA column statistics
ColumnsApi	GetPAColumnById	GET /analytics/lookups/v2/engines/pa/columns/{id}	Get PA column settings
ColumnsApi	GetPAColumns	GET /analytics/lookups/v2/engines/pa/columns	Get PA columns
ComponentsApi	GetPAComponentById	GET /analytics/lookups/v2/engines/pa/components/{id}	Get PA component by id
ComponentsApi	GetPAComponents	GET /analytics/lookups/v2/engines/pa/components	Get PA components
ComponentsApi	GetSPARComponents	GET /analytics/lookups/v2/engines/spar/components	Get SPAR components
ComponentsApi	GetVaultComponentById	GET /analytics/lookups/v2/engines/vault/components/{id}	Get Vault component by id
ComponentsApi	GetVaultComponents	GET /analytics/lookups/v2/engines/vault/components	Get Vault components
ConfigurationsApi	GetVaultConfigurationById	GET /analytics/lookups/v2/engines/vault/configurations/{id}	Get Vault configuration by id
ConfigurationsApi	GetVaultConfigurations	GET /analytics/lookups/v2/engines/vault/configurations	Get Vault configurations
CurrenciesApi	GetPACurrencies	GET /analytics/lookups/v2/engines/pa/currencies	Get PA currencies
DatesApi	ConvertPADatesToAbsoluteFormat	GET /analytics/lookups/v2/engines/pa/dates	Convert PA dates to absolute format
DatesApi	ConvertVaultDatesToAbsoluteFormat	GET /analytics/lookups/v2/engines/vault/dates	Convert Vault dates to absolute format
DocumentsApi	GetPA3Documents	GET /analytics/lookups/v2/engines/pa/documents/{path}	Get PA3 documents and sub-directories in a directory
DocumentsApi	GetPubDocuments	GET /analytics/lookups/v2/engines/pub/documents/{path}	Gets Publisher documents and sub-directories in a directory
DocumentsApi	GetSPAR3Documents	GET /analytics/lookups/v2/engines/spar/documents/{path}	Gets SPAR3 documents and sub-directories in a directory
DocumentsApi	GetVaultDocuments	GET /analytics/lookups/v2/engines/vault/documents/{path}	Get Vault documents and sub-directories in a directory
FrequenciesApi	GetPAFrequencies	GET /analytics/lookups/v2/engines/pa/frequencies	Get PA frequencies
FrequenciesApi	GetSPARFrequencies	GET /analytics/lookups/v2/engines/spar/frequencies	Get SPAR frequencies
FrequenciesApi	GetVaultFrequencies	GET /analytics/lookups/v2/engines/vault/frequencies	Get Vault frequencies
GroupsApi	GetPAGroups	GET /analytics/lookups/v2/engines/pa/groups	Get PA groups
PACalculationsApi	CancelPACalculationById	DELETE /analytics/engines/pa/v2/calculations/{id}	Cancel PA calculation by id
PACalculationsApi	GetPACalculationById	GET /analytics/engines/pa/v2/calculations/{id}	Get PA calculation by id
PACalculationsApi	RunPACalculation	POST /analytics/engines/pa/v2/calculations	Run PA Calculation
SPARBenchmarkApi	GetSPARBenchmarkById	GET /analytics/lookups/v2/engines/spar/benchmarks	Get SPAR benchmark details
SPARCalculationsApi	CancelSPARCalculationById	DELETE /analytics/engines/spar/v2/calculations/{id}	Cancel SPAR calculation
SPARCalculationsApi	GetSPARCalculationById	GET /analytics/engines/spar/v2/calculations/{id}	Get SPAR calculation by id
SPARCalculationsApi	RunSPARCalculation	POST /analytics/engines/spar/v2/calculations	Run SPAR Calculation
VaultCalculationsApi	CancelVaultCalculationById	DELETE /analytics/engines/vault/v2/calculations/{id}	Cancel Vault calculation by id
VaultCalculationsApi	GetVaultCalculationById	GET /analytics/engines/vault/v2/calculations/{id}	Get Vault calculation by id
VaultCalculationsApi	RunVaultCalculation	POST /analytics/engines/vault/v2/calculations	Run Vault Calculation
UtilityApi	getByUrl	GET {url}	Get by url

Documentation for Models

• Model.AccountDirectories
• Model.Calculation
• Model.CalculationStatus
• Model.CalculationStatusSummary
• Model.CalculationUnitStatus
• Model.Column
• Model.ColumnStatistic
• Model.ColumnSummary
• Model.ComponentAccount
• Model.ComponentBenchmark
• Model.ComponentSummary
• Model.ConfigurationAccount
• Model.Currency
• Model.DateParametersSummary
• Model.DocumentDirectories
• Model.Frequency
• Model.Group
• Model.PACalculationColumn
• Model.PACalculationGroup
• Model.PACalculationParameters
• Model.PAComponent
• Model.PADateParameters
• Model.PAIdentifier
• Model.PubCalculationParameters
• Model.PubDateParameters
• Model.PubIdentifier
• Model.SPARBenchmark
• Model.SPARCalculationParameters
• Model.SPARDateParameters
• Model.SPARIdentifier
• Model.VaultCalculationParameters
• Model.VaultComponent
• Model.VaultConfiguration
• Model.VaultConfigurationSummary
• Model.VaultDateParameters
• Model.VaultIdentifier

Documentation for Authorization

Basic

• Type: HTTP basic authentication