View on GitHub

analyticsapi-engines-java-sdk

engines-sdk

Engines API

Allow clients to fetch Analytics through APIs.

For more information, please visit https://developer.factset.com/contact

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project’s POM:

<dependency>
  <groupId>com.factset.analyticsapi</groupId>
  <artifactId>engines-sdk</artifactId>
  <version>6.2.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project’s build file:

compile "com.factset.analyticsapi:engines-sdk:6.2.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

Usage

To add a HTTP proxy for the API client, use ClientConfig:


import org.glassfish.jersey.apache.connector.ApacheConnectorProvider;
import org.glassfish.jersey.client.ClientConfig;
import org.glassfish.jersey.client.ClientProperties;
import factset.analyticsapi.engines.*;
import factset.analyticsapi.engines.api.AccountsApi;

...

ApiClient defaultClient = Configuration.getDefaultApiClient();
ClientConfig clientConfig = defaultClient.getClientConfig();
clientConfig.connectorProvider(new ApacheConnectorProvider());
clientConfig.property(ClientProperties.PROXY_URI, "http://proxy_url_here");
clientConfig.property(ClientProperties.PROXY_USERNAME, "proxy_username");
clientConfig.property(ClientProperties.PROXY_PASSWORD, "proxy_password");
defaultClient.setClientConfig(clientConfig);

AccountsApi apiInstance = new AccountsApi(defaultClient);

Getting Started

Please follow the installation instruction and execute the following Java code:


import factset.analyticsapi.engines.*;
import factset.analyticsapi.engines.auth.*;
import factset.analyticsapi.engines.models.*;
import factset.analyticsapi.engines.api.AccountsApi;

public class AccountsApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.factset.com");
        
        // Configure HTTP basic authorization: Basic
        HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
        Basic.setUsername("YOUR USERNAME");
        Basic.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: Bearer
        HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setBearerToken("BEARER TOKEN");

        AccountsApi apiInstance = new AccountsApi(defaultClient);
        String path = "Client:"; // String | The directory to get the accounts and sub-directories.
        try {
            AccountDirectoriesRoot result = apiInstance.getAccounts(path);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getAccounts");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getClientErrorResponse());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountsApi getAccounts GET /analytics/lookups/v3/accounts/{path} Get accounts and sub-directories in a directory
AccountsApi getSPARReturnsType GET /analytics/engines/spar/v3/accounts/{accountPath}/returns-type Get SPAR account returns type details
AfiOptimizerApi cancelOptimizationById DELETE /analytics/engines/afi/v3/optimizations/{id} Cancel AFI optimization by id
AfiOptimizerApi getOptimizationParameters GET /analytics/engines/afi/v3/optimizations/{id} Get AFI optimization parameters by id
AfiOptimizerApi getOptimizationResult GET /analytics/engines/afi/v3/optimizations/{id}/result Get AFI optimization result by id
AfiOptimizerApi getOptimizationStatusById GET /analytics/engines/afi/v3/optimizations/{id}/status Get AFI optimization status by id
AfiOptimizerApi postAndOptimize POST /analytics/engines/afi/v3/optimizations Create and Run AFI optimization
AfiOptimizerApi putAndOptimize PUT /analytics/engines/afi/v3/optimizations/{id} Create or Update AFI optimization and run it.
AxpOptimizerApi cancelOptimizationById DELETE /analytics/engines/axp/v3/optimizations/{id} Cancel Axioma optimization by id
AxpOptimizerApi getOptimizationParameters GET /analytics/engines/axp/v3/optimizations/{id} Get Axioma optimization parameters by id
AxpOptimizerApi getOptimizationResult GET /analytics/engines/axp/v3/optimizations/{id}/result Get Axioma optimization result by id
AxpOptimizerApi getOptimizationStatusById GET /analytics/engines/axp/v3/optimizations/{id}/status Get Axioma optimization status by id
AxpOptimizerApi postAndOptimize POST /analytics/engines/axp/v3/optimizations Create and Run Axioma optimization
AxpOptimizerApi putAndOptimize PUT /analytics/engines/axp/v3/optimizations/{id} Create or Update Axioma optimization and run it.
BenchmarksApi getSPARBenchmarkById GET /analytics/engines/spar/v3/benchmarks Get SPAR benchmark details
BpmOptimizerApi cancelOptimizationById DELETE /analytics/engines/bpm/v3/optimizations/{id} Cancel BPM optimization by id
BpmOptimizerApi getOptimizationParameters GET /analytics/engines/bpm/v3/optimizations/{id} Get BPM optimization parameters by id
BpmOptimizerApi getOptimizationResult GET /analytics/engines/bpm/v3/optimizations/{id}/result Get BPM optimization result by id
BpmOptimizerApi getOptimizationStatusById GET /analytics/engines/bpm/v3/optimizations/{id}/status Get BPM optimization status by id
BpmOptimizerApi postAndOptimize POST /analytics/engines/bpm/v3/optimizations Create and Run BPM optimization
BpmOptimizerApi putAndOptimize PUT /analytics/engines/bpm/v3/optimizations/{id} Create or Update BPM optimization and run it.
ColumnStatisticsApi getPAColumnStatistics GET /analytics/engines/pa/v3/columnstatistics Get PA column statistics
ColumnsApi getPAColumnById GET /analytics/engines/pa/v3/columns/{id} Get PA column settings
ColumnsApi getPAColumns GET /analytics/engines/pa/v3/columns Get PA columns
ComponentsApi getPAComponentById GET /analytics/engines/pa/v3/components/{id} Get PA component by id
ComponentsApi getPAComponents GET /analytics/engines/pa/v3/components Get PA components
ComponentsApi getSPARComponentById GET /analytics/engines/spar/v3/components/{id} Get SPAR component by id
ComponentsApi getSPARComponents GET /analytics/engines/spar/v3/components Get SPAR components
ComponentsApi getVaultComponentById GET /analytics/engines/vault/v3/components/{id} Get Vault component by id
ComponentsApi getVaultComponents GET /analytics/engines/vault/v3/components Get Vault components
ConfigurationsApi getVaultConfigurationById GET /analytics/engines/vault/v3/configurations/{id} Get Vault configuration by id
ConfigurationsApi getVaultConfigurations GET /analytics/engines/vault/v3/configurations Get Vault configurations
CurrenciesApi getCurrencies GET /analytics/lookups/v3/currencies Get currencies
DatesApi convertPADatesToAbsoluteFormat GET /analytics/engines/pa/v3/dates Convert PA dates to absolute format
DatesApi convertVaultDatesToAbsoluteFormat GET /analytics/engines/vault/v3/dates Convert Vault dates to absolute format
DiscountCurvesApi getAllFIDiscountCurves GET /analytics/engines/fi/v3/discount-curves Get Discount Curves
DocumentsApi getPA3Documents GET /analytics/engines/pa/v3/documents/{path} Get PA3 documents and sub-directories in a directory
DocumentsApi getPubDocuments GET /analytics/engines/pub/v3/documents/{path} Gets Publisher documents and sub-directories in a directory
DocumentsApi getSPAR3Documents GET /analytics/engines/spar/v3/documents/{path} Gets SPAR3 documents and sub-directories in a directory
DocumentsApi getVaultDocuments GET /analytics/engines/vault/v3/documents/{path} Get Vault documents and sub-directories in a directory
FiCalculationsApi cancelCalculationById DELETE /analytics/engines/fi/v3/calculations/{id} Cancel FI calculation by id
FiCalculationsApi getCalculationParameters GET /analytics/engines/fi/v3/calculations/{id} Get FI calculation parameters by id
FiCalculationsApi getCalculationResult GET /analytics/engines/fi/v3/calculations/{id}/result Get FI calculation result by id
FiCalculationsApi getCalculationStatusById GET /analytics/engines/fi/v3/calculations/{id}/status Get FI calculation status by id
FiCalculationsApi postAndCalculate POST /analytics/engines/fi/v3/calculations Create and Run FI calculation
FiCalculationsApi putAndCalculate PUT /analytics/engines/fi/v3/calculations/{id} Create or Update FI calculation and run it.
FiabCalculationsApi getCalculationById GET /analytics/engines/fiab/v1/calculations/{id} Get FIAB calculation by id
FiabCalculationsApi getCalculationStatusSummaries GET /analytics/engines/fiab/v1/calculations Get all FIAB calculation summaries
FiabCalculationsApi runCalculation POST /analytics/engines/fiab/v1/calculations Run FIAB calculation
FpoOptimizerApi cancelOptimizationById DELETE /analytics/engines/fpo/v3/optimizations/{id} Cancel FPO optimization by id
FpoOptimizerApi getOptimizationParameters GET /analytics/engines/fpo/v3/optimizations/{id} Get FPO optimization parameters by id
FpoOptimizerApi getOptimizationResult GET /analytics/engines/fpo/v3/optimizations/{id}/result Get FPO optimization result by id
FpoOptimizerApi getOptimizationStatusById GET /analytics/engines/fpo/v3/optimizations/{id}/status Get FPO optimization status by id
FpoOptimizerApi postAndOptimize POST /analytics/engines/fpo/v3/optimizations Create and Run FPO optimization
FpoOptimizerApi putAndOptimize PUT /analytics/engines/fpo/v3/optimizations/{id} Create or Update FPO optimization and run it.
FrequenciesApi getPAFrequencies GET /analytics/engines/pa/v3/frequencies Get PA frequencies
FrequenciesApi getSPARFrequencies GET /analytics/engines/spar/v3/frequencies Get SPAR frequencies
FrequenciesApi getVaultFrequencies GET /analytics/engines/vault/v3/frequencies Get Vault frequencies
GroupsApi getPAGroupingFrequencies GET /analytics/engines/pa/v3/grouping-frequencies Get PA grouping frequencies
GroupsApi getPAGroups GET /analytics/engines/pa/v3/groups Get PA groups
LinkedPaTemplatesApi createLinkedPATemplates POST /analytics/engines/pa/v3/linked-templates Create a linked PA template
LinkedPaTemplatesApi deleteLinkedPATemplates DELETE /analytics/engines/pa/v3/linked-templates/{id} Delete a linked PA template.
LinkedPaTemplatesApi getLinkedPATemplates GET /analytics/engines/pa/v3/linked-templates Get linked PA templates
LinkedPaTemplatesApi getLinkedPATemplatesById GET /analytics/engines/pa/v3/linked-templates/{id} Get linked PA template by id
LinkedPaTemplatesApi updateLinkedPATemplates PUT /analytics/engines/pa/v3/linked-templates/{id} Update a linked PA template
NpoOptimizerApi cancelOptimizationById DELETE /analytics/engines/npo/v3/optimizations/{id} Cancel NPO optimization by id
NpoOptimizerApi getOptimizationParameters GET /analytics/engines/npo/v3/optimizations/{id} Get NPO optimization parameters by id
NpoOptimizerApi getOptimizationResult GET /analytics/engines/npo/v3/optimizations/{id}/result Get NPO optimization result by id
NpoOptimizerApi getOptimizationStatusById GET /analytics/engines/npo/v3/optimizations/{id}/status Get NPO optimization status by id
NpoOptimizerApi postAndOptimize POST /analytics/engines/npo/v3/optimizations Create and Run NPO optimization
NpoOptimizerApi putAndOptimize PUT /analytics/engines/npo/v3/optimizations/{id} Create or Update NPO optimization and run it.
PaCalculationsApi cancelCalculationById DELETE /analytics/engines/pa/v3/calculations/{id} Cancel PA calculation by id
PaCalculationsApi getAllCalculations GET /analytics/engines/pa/v3/calculations Get all calculations
PaCalculationsApi getCalculationParameters GET /analytics/engines/pa/v3/calculations/{id} Get PA calculation parameters by id
PaCalculationsApi getCalculationStatusById GET /analytics/engines/pa/v3/calculations/{id}/status Get PA calculation status by id
PaCalculationsApi getCalculationUnitResultById GET /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result Get PA calculation result by id
PaCalculationsApi postAndCalculate POST /analytics/engines/pa/v3/calculations Create and Run PA calculation
PaCalculationsApi putAndCalculate PUT /analytics/engines/pa/v3/calculations/{id} Create or Update PA calculation and run it.
PricingSourcesApi getPAPricingSources GET /analytics/engines/pa/v3/pricing-sources Get PA pricing sources
PubCalculationsApi cancelCalculationById DELETE /analytics/engines/pub/v3/calculations/{id} Cancel Pub calculation by id
PubCalculationsApi getAllCalculations GET /analytics/engines/pub/v3/calculations Get all calculations
PubCalculationsApi getCalculationParameters GET /analytics/engines/pub/v3/calculations/{id} Get Pub calculation parameters by id
PubCalculationsApi getCalculationStatusById GET /analytics/engines/pub/v3/calculations/{id}/status Get Pub calculation status by id
PubCalculationsApi getCalculationUnitResultById GET /analytics/engines/pub/v3/calculations/{id}/units/{unitId}/result Get Pub calculation result by id
PubCalculationsApi postAndCalculate POST /analytics/engines/pub/v3/calculations Create and Run Pub calculation
PubCalculationsApi putAndCalculate PUT /analytics/engines/pub/v3/calculations/{id} Create or Update Pub calculation and run it.
QuantCalculationsApi cancelCalculationById DELETE /analytics/engines/quant/v3/calculations/{id} Cancel Quant calculation by id
QuantCalculationsApi getAllCalculations GET /analytics/engines/quant/v3/calculations Get all calculations
QuantCalculationsApi getCalculationParameters GET /analytics/engines/quant/v3/calculations/{id} Get Quant Engine calculation parameters by id
QuantCalculationsApi getCalculationStatusById GET /analytics/engines/quant/v3/calculations/{id}/status Get Quant Engine calculation status by id
QuantCalculationsApi getCalculationUnitInfoById GET /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/info Get Quant Engine calculation metadata information by id
QuantCalculationsApi getCalculationUnitResultById GET /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/result Get Quant Engine calculation result by id
QuantCalculationsApi postAndCalculate POST /analytics/engines/quant/v3/calculations Create and Run Quant Engine calculation
QuantCalculationsApi putAndCalculate PUT /analytics/engines/quant/v3/calculations/{id} Create or update Quant Engine calculation and run it.
SparCalculationsApi cancelCalculationById DELETE /analytics/engines/spar/v3/calculations/{id} Cancel SPAR calculation
SparCalculationsApi getAllCalculations GET /analytics/engines/spar/v3/calculations Get all calculations
SparCalculationsApi getCalculationParameters GET /analytics/engines/spar/v3/calculations/{id} Get SPAR calculation parameters by id
SparCalculationsApi getCalculationStatusById GET /analytics/engines/spar/v3/calculations/{id}/status Get SPAR calculation status by id
SparCalculationsApi getCalculationUnitResultById GET /analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result Get SPAR calculation result by id
SparCalculationsApi postAndCalculate POST /analytics/engines/spar/v3/calculations Create and Run SPAR calculation
SparCalculationsApi putAndCalculate PUT /analytics/engines/spar/v3/calculations/{id} Create or Update SPAR calculation and run it.
StrategyDocumentsApi getAxiomaEquityStrategyDocuments GET /analytics/engines/axp/v3/strategies/{path} Get Axioma Equity strategy documents and sub-directories in a directory
StrategyDocumentsApi getAxiomaFIStrategyDocuments GET /analytics/engines/afi/v3/strategies/{path} Get Axioma FI strategy documents and sub-directories in a directory
StrategyDocumentsApi getBarraStrategyDocuments GET /analytics/engines/bpm/v3/strategies/{path} Get Barra strategy documents and sub-directories in a directory
StrategyDocumentsApi getFPOStrategyDocuments GET /analytics/engines/fpo/v3/strategies/{path} Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory
StrategyDocumentsApi getNorthfieldStrategyDocuments GET /analytics/engines/npo/v3/strategies/{path} Get Northfield strategy documents and sub-directories in a directory
TemplatedPaComponentsApi createTemplatedPAComponents POST /analytics/engines/pa/v3/templated-components Create templated PA component
TemplatedPaComponentsApi deleteTemplatedPAComponents DELETE /analytics/engines/pa/v3/templated-components/{id} Delete templated PA component
TemplatedPaComponentsApi getTemplatedPAComponentById GET /analytics/engines/pa/v3/templated-components/{id} Get templated PA component by id
TemplatedPaComponentsApi getTemplatedPAComponentsInPath GET /analytics/engines/pa/v3/templated-components Get templated PA components in path
TemplatedPaComponentsApi updateTemplatedPAComponents PUT /analytics/engines/pa/v3/templated-components/{id} Update templated PA component
UnlinkedPaTemplatesApi createUnlinkedPATemplates POST /analytics/engines/pa/v3/unlinked-templates Create unlinked PA template
UnlinkedPaTemplatesApi deleteUnlinkedPATemplates DELETE /analytics/engines/pa/v3/unlinked-templates/{id} Delete unlinked PA template
UnlinkedPaTemplatesApi getDefaultUnlinkedPATemplateTypes GET /analytics/engines/pa/v3/unlinked-templates/template-types Get default unlinked PA template types.
UnlinkedPaTemplatesApi getDetailsType GET /analytics/engines/pa/v3/unlinked-templates/template-types/{id} Get unlinked PA template type details by id.
UnlinkedPaTemplatesApi getUnlinkedPATemplates GET /analytics/engines/pa/v3/unlinked-templates Get unlinked PA templates
UnlinkedPaTemplatesApi getUnlinkedPATemplatesById GET /analytics/engines/pa/v3/unlinked-templates/{id} Get unlinked PA template details by id
UnlinkedPaTemplatesApi updateUnlinkedPATemplates PUT /analytics/engines/pa/v3/unlinked-templates/{id} Update unlinked PA template
VaultCalculationsApi cancelCalculationById DELETE /analytics/engines/vault/v3/calculations/{id} Cancel Vault calculation by id
VaultCalculationsApi getAllCalculations GET /analytics/engines/vault/v3/calculations Get all calculations
VaultCalculationsApi getCalculationParameters GET /analytics/engines/vault/v3/calculations/{id} Get Vault calculation parameters by id
VaultCalculationsApi getCalculationStatusById GET /analytics/engines/vault/v3/calculations/{id}/status Get Vault calculation status by id
VaultCalculationsApi getCalculationUnitResultById GET /analytics/engines/vault/v3/calculations/{id}/units/{unitId}/result Get Vault calculation result by id
VaultCalculationsApi postAndCalculate POST /analytics/engines/vault/v3/calculations Create and Run Vault calculation
VaultCalculationsApi putAndCalculate PUT /analytics/engines/vault/v3/calculations/{id} Create or Update Vault calculation and run it.

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

Basic

Bearer

Recommendation

It’s recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

api@factset.com