diff --git a/auto-generated-sdk/.openapi-generator/FILES b/auto-generated-sdk/.openapi-generator/FILES
index 729761b0..040e86e3 100644
--- a/auto-generated-sdk/.openapi-generator/FILES
+++ b/auto-generated-sdk/.openapi-generator/FILES
@@ -24,7 +24,6 @@ docs/BPMOptimizationParametersRoot.md
docs/BPMOptimizerStrategy.md
docs/BPMOptimizerStrategyAlphaOverride.md
docs/BPMOptimizerStrategyOverrides.md
-docs/BenchmarksApi.md
docs/BpmOptimizerApi.md
docs/CalculationInfo.md
docs/CalculationInfoRoot.md
@@ -122,9 +121,11 @@ docs/NPOOptimizerStrategy.md
docs/NPOOptimizerStrategyOverrides.md
docs/NpoOptimizerApi.md
docs/ObjectRoot.md
+docs/OneOfFieldsFields.md
docs/OneOfQuantDates.md
docs/OneOfQuantFormulas.md
docs/OneOfQuantUniverse.md
+docs/OneOfSMFields.md
docs/OptimalPortfolio.md
docs/Optimization.md
docs/OptimizerAccount.md
@@ -179,16 +180,26 @@ docs/QuantUniversalScreenParameterObsolete.md
docs/QuantUniversalScreenUniverse.md
docs/QuantUniversalScreenUniverseObsolete.md
docs/QuantUniverse.md
-docs/ReturnType.md
-docs/SPARAccounts.md
-docs/SPARAccountsRoot.md
-docs/SPARBenchmark.md
-docs/SPARBenchmarkRoot.md
-docs/SPARCalculationParameters.md
-docs/SPARCalculationParametersRoot.md
-docs/SPARDateParameters.md
-docs/SPARIdentifier.md
-docs/SparCalculationsApi.md
+docs/SMBondFields.md
+docs/SMCreateParameters.md
+docs/SMCreateParametersRoot.md
+docs/SMCreateResponse.md
+docs/SMCreateResponseRoot.md
+docs/SMCustomCashFlowFields.md
+docs/SMDeleteParameters.md
+docs/SMDeleteParametersRoot.md
+docs/SMDeleteResponse.md
+docs/SMDeleteResponseRoot.md
+docs/SMError.md
+docs/SMFields.md
+docs/SMRetrieveParameters.md
+docs/SMRetrieveParametersRoot.md
+docs/SMRetrieveResponse.md
+docs/SMRetrieveResponseRoot.md
+docs/SMTemplateFieldProperties.md
+docs/SMTemplateFieldPropertiesRoot.md
+docs/SMWarning.md
+docs/SecurityModelingApi.md
docs/StrategyDocumentsApi.md
docs/TemplateContentTypes.md
docs/TemplatedPAComponent.md
@@ -219,6 +230,9 @@ docs/UnlinkedPATemplateSummaryRoot.md
docs/UnlinkedPATemplateUpdateParameters.md
docs/UnlinkedPATemplateUpdateParametersRoot.md
docs/UnlinkedPaTemplatesApi.md
+docs/VaultAttributionLoaderApi.md
+docs/VaultAttributionLoaderResponse.md
+docs/VaultAttributionLoaderResponseRoot.md
docs/VaultCalculationParameters.md
docs/VaultCalculationParametersRoot.md
docs/VaultCalculationsApi.md
@@ -254,7 +268,6 @@ src/main/java/factset/analyticsapi/engines/StringUtil.java
src/main/java/factset/analyticsapi/engines/api/AccountsApi.java
src/main/java/factset/analyticsapi/engines/api/AfiOptimizerApi.java
src/main/java/factset/analyticsapi/engines/api/AxpOptimizerApi.java
-src/main/java/factset/analyticsapi/engines/api/BenchmarksApi.java
src/main/java/factset/analyticsapi/engines/api/BpmOptimizerApi.java
src/main/java/factset/analyticsapi/engines/api/ColumnStatisticsApi.java
src/main/java/factset/analyticsapi/engines/api/ColumnsApi.java
@@ -275,10 +288,11 @@ src/main/java/factset/analyticsapi/engines/api/PaCalculationsApi.java
src/main/java/factset/analyticsapi/engines/api/PricingSourcesApi.java
src/main/java/factset/analyticsapi/engines/api/PubCalculationsApi.java
src/main/java/factset/analyticsapi/engines/api/QuantCalculationsApi.java
-src/main/java/factset/analyticsapi/engines/api/SparCalculationsApi.java
+src/main/java/factset/analyticsapi/engines/api/SecurityModelingApi.java
src/main/java/factset/analyticsapi/engines/api/StrategyDocumentsApi.java
src/main/java/factset/analyticsapi/engines/api/TemplatedPaComponentsApi.java
src/main/java/factset/analyticsapi/engines/api/UnlinkedPaTemplatesApi.java
+src/main/java/factset/analyticsapi/engines/api/VaultAttributionLoaderApi.java
src/main/java/factset/analyticsapi/engines/api/VaultCalculationsApi.java
src/main/java/factset/analyticsapi/engines/auth/ApiKeyAuth.java
src/main/java/factset/analyticsapi/engines/auth/Authentication.java
@@ -382,9 +396,11 @@ src/main/java/factset/analyticsapi/engines/models/NPOOptimizationParametersRoot.
src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategy.java
src/main/java/factset/analyticsapi/engines/models/NPOOptimizerStrategyOverrides.java
src/main/java/factset/analyticsapi/engines/models/ObjectRoot.java
+src/main/java/factset/analyticsapi/engines/models/OneOfFieldsFields.java
src/main/java/factset/analyticsapi/engines/models/OneOfQuantDates.java
src/main/java/factset/analyticsapi/engines/models/OneOfQuantFormulas.java
src/main/java/factset/analyticsapi/engines/models/OneOfQuantUniverse.java
+src/main/java/factset/analyticsapi/engines/models/OneOfSMFields.java
src/main/java/factset/analyticsapi/engines/models/OptimalPortfolio.java
src/main/java/factset/analyticsapi/engines/models/Optimization.java
src/main/java/factset/analyticsapi/engines/models/OptimizerAccount.java
@@ -435,15 +451,25 @@ src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenParameterO
src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverse.java
src/main/java/factset/analyticsapi/engines/models/QuantUniversalScreenUniverseObsolete.java
src/main/java/factset/analyticsapi/engines/models/QuantUniverse.java
-src/main/java/factset/analyticsapi/engines/models/ReturnType.java
-src/main/java/factset/analyticsapi/engines/models/SPARAccounts.java
-src/main/java/factset/analyticsapi/engines/models/SPARAccountsRoot.java
-src/main/java/factset/analyticsapi/engines/models/SPARBenchmark.java
-src/main/java/factset/analyticsapi/engines/models/SPARBenchmarkRoot.java
-src/main/java/factset/analyticsapi/engines/models/SPARCalculationParameters.java
-src/main/java/factset/analyticsapi/engines/models/SPARCalculationParametersRoot.java
-src/main/java/factset/analyticsapi/engines/models/SPARDateParameters.java
-src/main/java/factset/analyticsapi/engines/models/SPARIdentifier.java
+src/main/java/factset/analyticsapi/engines/models/SMBondFields.java
+src/main/java/factset/analyticsapi/engines/models/SMCreateParameters.java
+src/main/java/factset/analyticsapi/engines/models/SMCreateParametersRoot.java
+src/main/java/factset/analyticsapi/engines/models/SMCreateResponse.java
+src/main/java/factset/analyticsapi/engines/models/SMCreateResponseRoot.java
+src/main/java/factset/analyticsapi/engines/models/SMCustomCashFlowFields.java
+src/main/java/factset/analyticsapi/engines/models/SMDeleteParameters.java
+src/main/java/factset/analyticsapi/engines/models/SMDeleteParametersRoot.java
+src/main/java/factset/analyticsapi/engines/models/SMDeleteResponse.java
+src/main/java/factset/analyticsapi/engines/models/SMDeleteResponseRoot.java
+src/main/java/factset/analyticsapi/engines/models/SMError.java
+src/main/java/factset/analyticsapi/engines/models/SMFields.java
+src/main/java/factset/analyticsapi/engines/models/SMRetrieveParameters.java
+src/main/java/factset/analyticsapi/engines/models/SMRetrieveParametersRoot.java
+src/main/java/factset/analyticsapi/engines/models/SMRetrieveResponse.java
+src/main/java/factset/analyticsapi/engines/models/SMRetrieveResponseRoot.java
+src/main/java/factset/analyticsapi/engines/models/SMTemplateFieldProperties.java
+src/main/java/factset/analyticsapi/engines/models/SMTemplateFieldPropertiesRoot.java
+src/main/java/factset/analyticsapi/engines/models/SMWarning.java
src/main/java/factset/analyticsapi/engines/models/TemplateContentTypes.java
src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponent.java
src/main/java/factset/analyticsapi/engines/models/TemplatedPAComponentParameters.java
@@ -471,6 +497,8 @@ src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummary.java
src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateSummaryRoot.java
src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParameters.java
src/main/java/factset/analyticsapi/engines/models/UnlinkedPATemplateUpdateParametersRoot.java
+src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponse.java
+src/main/java/factset/analyticsapi/engines/models/VaultAttributionLoaderResponseRoot.java
src/main/java/factset/analyticsapi/engines/models/VaultCalculationParameters.java
src/main/java/factset/analyticsapi/engines/models/VaultCalculationParametersRoot.java
src/main/java/factset/analyticsapi/engines/models/VaultComponent.java
diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md
index ef28087f..781a6b05 100644
--- a/auto-generated-sdk/README.md
+++ b/auto-generated-sdk/README.md
@@ -3,7 +3,7 @@
Engines API
-- API version: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
+- API version: v3:[pa,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,security-modeling,others],v1:[fiab]
Allow clients to fetch Analytics through APIs.
@@ -119,7 +119,7 @@ public class AccountsApiExample {
Bearer.setBearerToken("BEARER TOKEN");
AccountsApi apiInstance = new AccountsApi(defaultClient);
- String path = ""; // String | The directory to get the accounts and sub-directories in
+ String path = ""; // String | The directory to get the accounts and sub-directories.
try {
AccountDirectoriesRoot result = apiInstance.getAccounts(path);
System.out.println(result);
@@ -142,7 +142,6 @@ All URIs are relative to *https://api.factset.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountsApi* | [**getAccounts**](docs/AccountsApi.md#getAccounts) | **GET** /analytics/lookups/v3/accounts/{path} | Get accounts and sub-directories in a directory
-*AccountsApi* | [**getSPARReturnsType**](docs/AccountsApi.md#getSPARReturnsType) | **GET** /analytics/engines/spar/v3/accounts/{accountPath}/returns-type | Get SPAR account returns type details
*AfiOptimizerApi* | [**cancelOptimizationById**](docs/AfiOptimizerApi.md#cancelOptimizationById) | **DELETE** /analytics/engines/afi/v3/optimizations/{id} | Cancel AFI optimization by id
*AfiOptimizerApi* | [**getOptimizationParameters**](docs/AfiOptimizerApi.md#getOptimizationParameters) | **GET** /analytics/engines/afi/v3/optimizations/{id} | Get AFI optimization parameters by id
*AfiOptimizerApi* | [**getOptimizationResult**](docs/AfiOptimizerApi.md#getOptimizationResult) | **GET** /analytics/engines/afi/v3/optimizations/{id}/result | Get AFI optimization result by id
@@ -155,7 +154,6 @@ Class | Method | HTTP request | Description
*AxpOptimizerApi* | [**getOptimizationStatusById**](docs/AxpOptimizerApi.md#getOptimizationStatusById) | **GET** /analytics/engines/axp/v3/optimizations/{id}/status | Get Axioma optimization status by id
*AxpOptimizerApi* | [**postAndOptimize**](docs/AxpOptimizerApi.md#postAndOptimize) | **POST** /analytics/engines/axp/v3/optimizations | Create and Run Axioma optimization
*AxpOptimizerApi* | [**putAndOptimize**](docs/AxpOptimizerApi.md#putAndOptimize) | **PUT** /analytics/engines/axp/v3/optimizations/{id} | Create or Update Axioma optimization and run it.
-*BenchmarksApi* | [**getSPARBenchmarkById**](docs/BenchmarksApi.md#getSPARBenchmarkById) | **GET** /analytics/engines/spar/v3/benchmarks | Get SPAR benchmark details
*BpmOptimizerApi* | [**cancelOptimizationById**](docs/BpmOptimizerApi.md#cancelOptimizationById) | **DELETE** /analytics/engines/bpm/v3/optimizations/{id} | Cancel BPM optimization by id
*BpmOptimizerApi* | [**getOptimizationParameters**](docs/BpmOptimizerApi.md#getOptimizationParameters) | **GET** /analytics/engines/bpm/v3/optimizations/{id} | Get BPM optimization parameters by id
*BpmOptimizerApi* | [**getOptimizationResult**](docs/BpmOptimizerApi.md#getOptimizationResult) | **GET** /analytics/engines/bpm/v3/optimizations/{id}/result | Get BPM optimization result by id
@@ -167,7 +165,6 @@ Class | Method | HTTP request | Description
*ColumnsApi* | [**getPAColumns**](docs/ColumnsApi.md#getPAColumns) | **GET** /analytics/engines/pa/v3/columns | Get PA columns
*ComponentsApi* | [**getPAComponentById**](docs/ComponentsApi.md#getPAComponentById) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id
*ComponentsApi* | [**getPAComponents**](docs/ComponentsApi.md#getPAComponents) | **GET** /analytics/engines/pa/v3/components | Get PA components
-*ComponentsApi* | [**getSPARComponents**](docs/ComponentsApi.md#getSPARComponents) | **GET** /analytics/engines/spar/v3/components | Get SPAR components
*ComponentsApi* | [**getVaultComponentById**](docs/ComponentsApi.md#getVaultComponentById) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id
*ComponentsApi* | [**getVaultComponents**](docs/ComponentsApi.md#getVaultComponents) | **GET** /analytics/engines/vault/v3/components | Get Vault components
*ConfigurationsApi* | [**getVaultConfigurationById**](docs/ConfigurationsApi.md#getVaultConfigurationById) | **GET** /analytics/engines/vault/v3/configurations/{id} | Get Vault configuration by id
@@ -178,7 +175,6 @@ Class | Method | HTTP request | Description
*DiscountCurvesApi* | [**getAllFIDiscountCurves**](docs/DiscountCurvesApi.md#getAllFIDiscountCurves) | **GET** /analytics/engines/fi/v3/discount-curves | Get Discount Curves
*DocumentsApi* | [**getPA3Documents**](docs/DocumentsApi.md#getPA3Documents) | **GET** /analytics/engines/pa/v3/documents/{path} | Get PA3 documents and sub-directories in a directory
*DocumentsApi* | [**getPubDocuments**](docs/DocumentsApi.md#getPubDocuments) | **GET** /analytics/engines/pub/v3/documents/{path} | Gets Publisher documents and sub-directories in a directory
-*DocumentsApi* | [**getSPAR3Documents**](docs/DocumentsApi.md#getSPAR3Documents) | **GET** /analytics/engines/spar/v3/documents/{path} | Gets SPAR3 documents and sub-directories in a directory
*DocumentsApi* | [**getVaultDocuments**](docs/DocumentsApi.md#getVaultDocuments) | **GET** /analytics/engines/vault/v3/documents/{path} | Get Vault documents and sub-directories in a directory
*FiCalculationsApi* | [**cancelCalculationById**](docs/FiCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/fi/v3/calculations/{id} | Cancel FI calculation by id
*FiCalculationsApi* | [**getCalculationParameters**](docs/FiCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/fi/v3/calculations/{id} | Get FI calculation parameters by id
@@ -196,7 +192,6 @@ Class | Method | HTTP request | Description
*FpoOptimizerApi* | [**postAndOptimize**](docs/FpoOptimizerApi.md#postAndOptimize) | **POST** /analytics/engines/fpo/v3/optimizations | Create and Run FPO optimization
*FpoOptimizerApi* | [**putAndOptimize**](docs/FpoOptimizerApi.md#putAndOptimize) | **PUT** /analytics/engines/fpo/v3/optimizations/{id} | Create or Update FPO optimization and run it.
*FrequenciesApi* | [**getPAFrequencies**](docs/FrequenciesApi.md#getPAFrequencies) | **GET** /analytics/engines/pa/v3/frequencies | Get PA frequencies
-*FrequenciesApi* | [**getSPARFrequencies**](docs/FrequenciesApi.md#getSPARFrequencies) | **GET** /analytics/engines/spar/v3/frequencies | Get SPAR frequencies
*FrequenciesApi* | [**getVaultFrequencies**](docs/FrequenciesApi.md#getVaultFrequencies) | **GET** /analytics/engines/vault/v3/frequencies | Get Vault frequencies
*GroupsApi* | [**getPAGroupingFrequencies**](docs/GroupsApi.md#getPAGroupingFrequencies) | **GET** /analytics/engines/pa/v3/grouping-frequencies | Get PA grouping frequencies
*GroupsApi* | [**getPAGroups**](docs/GroupsApi.md#getPAGroups) | **GET** /analytics/engines/pa/v3/groups | Get PA groups
@@ -234,13 +229,10 @@ Class | Method | HTTP request | Description
*QuantCalculationsApi* | [**getCalculationUnitResultById**](docs/QuantCalculationsApi.md#getCalculationUnitResultById) | **GET** /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/result | Get Quant Engine calculation result by id
*QuantCalculationsApi* | [**postAndCalculate**](docs/QuantCalculationsApi.md#postAndCalculate) | **POST** /analytics/engines/quant/v3/calculations | Create and Run Quant Engine calculation
*QuantCalculationsApi* | [**putAndCalculate**](docs/QuantCalculationsApi.md#putAndCalculate) | **PUT** /analytics/engines/quant/v3/calculations/{id} | Create or update Quant Engine calculation and run it.
-*SparCalculationsApi* | [**cancelCalculationById**](docs/SparCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/spar/v3/calculations/{id} | Cancel SPAR calculation
-*SparCalculationsApi* | [**getAllCalculations**](docs/SparCalculationsApi.md#getAllCalculations) | **GET** /analytics/engines/spar/v3/calculations | Get all calculations
-*SparCalculationsApi* | [**getCalculationParameters**](docs/SparCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/spar/v3/calculations/{id} | Get SPAR calculation parameters by id
-*SparCalculationsApi* | [**getCalculationStatusById**](docs/SparCalculationsApi.md#getCalculationStatusById) | **GET** /analytics/engines/spar/v3/calculations/{id}/status | Get SPAR calculation status by id
-*SparCalculationsApi* | [**getCalculationUnitResultById**](docs/SparCalculationsApi.md#getCalculationUnitResultById) | **GET** /analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result | Get SPAR calculation result by id
-*SparCalculationsApi* | [**postAndCalculate**](docs/SparCalculationsApi.md#postAndCalculate) | **POST** /analytics/engines/spar/v3/calculations | Create and Run SPAR calculation
-*SparCalculationsApi* | [**putAndCalculate**](docs/SparCalculationsApi.md#putAndCalculate) | **PUT** /analytics/engines/spar/v3/calculations/{id} | Create or Update SPAR calculation and run it.
+*SecurityModelingApi* | [**deleteSecurities**](docs/SecurityModelingApi.md#deleteSecurities) | **POST** /analytics/security-modeling/v3/securities/delete | Delete existing securities
+*SecurityModelingApi* | [**getSecurities**](docs/SecurityModelingApi.md#getSecurities) | **POST** /analytics/security-modeling/v3/securities/retrieve | Get existing securities
+*SecurityModelingApi* | [**getTemplateFields**](docs/SecurityModelingApi.md#getTemplateFields) | **GET** /analytics/security-modeling/v3/templates/{template}/fields | Get template fields
+*SecurityModelingApi* | [**upsertSecurities**](docs/SecurityModelingApi.md#upsertSecurities) | **POST** /analytics/security-modeling/v3/securities/upsert | Create or update securities
*StrategyDocumentsApi* | [**getAxiomaEquityStrategyDocuments**](docs/StrategyDocumentsApi.md#getAxiomaEquityStrategyDocuments) | **GET** /analytics/engines/axp/v3/strategies/{path} | Get Axioma Equity strategy documents and sub-directories in a directory
*StrategyDocumentsApi* | [**getAxiomaFIStrategyDocuments**](docs/StrategyDocumentsApi.md#getAxiomaFIStrategyDocuments) | **GET** /analytics/engines/afi/v3/strategies/{path} | Get Axioma FI strategy documents and sub-directories in a directory
*StrategyDocumentsApi* | [**getBarraStrategyDocuments**](docs/StrategyDocumentsApi.md#getBarraStrategyDocuments) | **GET** /analytics/engines/bpm/v3/strategies/{path} | Get Barra strategy documents and sub-directories in a directory
@@ -258,6 +250,7 @@ Class | Method | HTTP request | Description
*UnlinkedPaTemplatesApi* | [**getUnlinkedPATemplates**](docs/UnlinkedPaTemplatesApi.md#getUnlinkedPATemplates) | **GET** /analytics/engines/pa/v3/unlinked-templates | Get unlinked PA templates
*UnlinkedPaTemplatesApi* | [**getUnlinkedPATemplatesById**](docs/UnlinkedPaTemplatesApi.md#getUnlinkedPATemplatesById) | **GET** /analytics/engines/pa/v3/unlinked-templates/{id} | Get unlinked PA template details by id
*UnlinkedPaTemplatesApi* | [**updateUnlinkedPATemplates**](docs/UnlinkedPaTemplatesApi.md#updateUnlinkedPATemplates) | **PUT** /analytics/engines/pa/v3/unlinked-templates/{id} | Update unlinked PA template
+*VaultAttributionLoaderApi* | [**vaultAttributionLoader**](docs/VaultAttributionLoaderApi.md#vaultAttributionLoader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader
*VaultCalculationsApi* | [**cancelCalculationById**](docs/VaultCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/vault/v3/calculations/{id} | Cancel Vault calculation by id
*VaultCalculationsApi* | [**getAllCalculations**](docs/VaultCalculationsApi.md#getAllCalculations) | **GET** /analytics/engines/vault/v3/calculations | Get all calculations
*VaultCalculationsApi* | [**getCalculationParameters**](docs/VaultCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/vault/v3/calculations/{id} | Get Vault calculation parameters by id
@@ -366,9 +359,11 @@ Class | Method | HTTP request | Description
- [NPOOptimizerStrategy](docs/NPOOptimizerStrategy.md)
- [NPOOptimizerStrategyOverrides](docs/NPOOptimizerStrategyOverrides.md)
- [ObjectRoot](docs/ObjectRoot.md)
+ - [OneOfFieldsFields](docs/OneOfFieldsFields.md)
- [OneOfQuantDates](docs/OneOfQuantDates.md)
- [OneOfQuantFormulas](docs/OneOfQuantFormulas.md)
- [OneOfQuantUniverse](docs/OneOfQuantUniverse.md)
+ - [OneOfSMFields](docs/OneOfSMFields.md)
- [OptimalPortfolio](docs/OptimalPortfolio.md)
- [Optimization](docs/Optimization.md)
- [OptimizerAccount](docs/OptimizerAccount.md)
@@ -419,15 +414,25 @@ Class | Method | HTTP request | Description
- [QuantUniversalScreenUniverse](docs/QuantUniversalScreenUniverse.md)
- [QuantUniversalScreenUniverseObsolete](docs/QuantUniversalScreenUniverseObsolete.md)
- [QuantUniverse](docs/QuantUniverse.md)
- - [ReturnType](docs/ReturnType.md)
- - [SPARAccounts](docs/SPARAccounts.md)
- - [SPARAccountsRoot](docs/SPARAccountsRoot.md)
- - [SPARBenchmark](docs/SPARBenchmark.md)
- - [SPARBenchmarkRoot](docs/SPARBenchmarkRoot.md)
- - [SPARCalculationParameters](docs/SPARCalculationParameters.md)
- - [SPARCalculationParametersRoot](docs/SPARCalculationParametersRoot.md)
- - [SPARDateParameters](docs/SPARDateParameters.md)
- - [SPARIdentifier](docs/SPARIdentifier.md)
+ - [SMBondFields](docs/SMBondFields.md)
+ - [SMCreateParameters](docs/SMCreateParameters.md)
+ - [SMCreateParametersRoot](docs/SMCreateParametersRoot.md)
+ - [SMCreateResponse](docs/SMCreateResponse.md)
+ - [SMCreateResponseRoot](docs/SMCreateResponseRoot.md)
+ - [SMCustomCashFlowFields](docs/SMCustomCashFlowFields.md)
+ - [SMDeleteParameters](docs/SMDeleteParameters.md)
+ - [SMDeleteParametersRoot](docs/SMDeleteParametersRoot.md)
+ - [SMDeleteResponse](docs/SMDeleteResponse.md)
+ - [SMDeleteResponseRoot](docs/SMDeleteResponseRoot.md)
+ - [SMError](docs/SMError.md)
+ - [SMFields](docs/SMFields.md)
+ - [SMRetrieveParameters](docs/SMRetrieveParameters.md)
+ - [SMRetrieveParametersRoot](docs/SMRetrieveParametersRoot.md)
+ - [SMRetrieveResponse](docs/SMRetrieveResponse.md)
+ - [SMRetrieveResponseRoot](docs/SMRetrieveResponseRoot.md)
+ - [SMTemplateFieldProperties](docs/SMTemplateFieldProperties.md)
+ - [SMTemplateFieldPropertiesRoot](docs/SMTemplateFieldPropertiesRoot.md)
+ - [SMWarning](docs/SMWarning.md)
- [TemplateContentTypes](docs/TemplateContentTypes.md)
- [TemplatedPAComponent](docs/TemplatedPAComponent.md)
- [TemplatedPAComponentParameters](docs/TemplatedPAComponentParameters.md)
@@ -455,6 +460,8 @@ Class | Method | HTTP request | Description
- [UnlinkedPATemplateSummaryRoot](docs/UnlinkedPATemplateSummaryRoot.md)
- [UnlinkedPATemplateUpdateParameters](docs/UnlinkedPATemplateUpdateParameters.md)
- [UnlinkedPATemplateUpdateParametersRoot](docs/UnlinkedPATemplateUpdateParametersRoot.md)
+ - [VaultAttributionLoaderResponse](docs/VaultAttributionLoaderResponse.md)
+ - [VaultAttributionLoaderResponseRoot](docs/VaultAttributionLoaderResponseRoot.md)
- [VaultCalculationParameters](docs/VaultCalculationParameters.md)
- [VaultCalculationParametersRoot](docs/VaultCalculationParametersRoot.md)
- [VaultComponent](docs/VaultComponent.md)
diff --git a/auto-generated-sdk/api/openapi.yaml b/auto-generated-sdk/api/openapi.yaml
index 19ee46ac..9815bd43 100644
--- a/auto-generated-sdk/api/openapi.yaml
+++ b/auto-generated-sdk/api/openapi.yaml
@@ -9,7 +9,7 @@ info:
name: Apache License, Version 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
title: Engines API
- version: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
+ version: v3:[pa,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,security-modeling,others],v1:[fiab]
externalDocs:
description: API Documentation
url: https://developer.factset.com/api-catalog/
@@ -19,19 +19,21 @@ security:
- Basic: []
Bearer: []
paths:
- /analytics/engines/spar/v3/accounts/{accountPath}/returns-type:
+ /analytics/lookups/v3/accounts/{path}:
get:
- description: This endpoint returns the returns type of account associated with
- SPAR
- operationId: getSPARReturnsType
+ description: This endpoint looks up all ACCT and ACTM files and sub-directories
+ in a given directory.
+ operationId: getAccounts
parameters:
- - description: URL encoded account path
+ - description: The directory to get the accounts and sub-directories.
explode: false
in: path
- name: accountPath
+ name: path
required: true
schema:
- description: URL encoded account path
+ default: ""
+ description: The directory to get the accounts and sub-directories.
+ example: 'Client:'
type: string
style: simple
responses:
@@ -39,9 +41,8 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/SPARAccountsRoot'
- description: Expected response, returns the list of return types for the
- account.
+ $ref: '#/components/schemas/AccountDirectoriesRoot'
+ description: Expected response, returns a list of accounts and directories
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -82,7 +83,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid account.
+ description: Invalid query parameter or value provided
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -123,7 +124,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Account not found.
+ description: Path not found
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -160,7 +161,7 @@ paths:
type: string
style: simple
"401":
- description: Missing or invalid authentication.
+ description: Missing or invalid authentication
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -216,7 +217,7 @@ paths:
type: string
style: simple
"406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ description: Unsupported Accept header. Header needs to be set to application/json
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -281,7 +282,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -300,7 +301,7 @@ paths:
type: string
style: simple
"503":
- description: Request timed out. Retry the request in sometime.
+ description: Request timed out. Retry the request in some time
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -318,79 +319,59 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get SPAR account returns type details
+ summary: Get accounts and sub-directories in a directory
tags:
- Accounts
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: SPARAccountsRoot
+ response-type: AccountDirectoriesRoot
x-accepts: application/json
- /analytics/lookups/v3/accounts/{path}:
- get:
- description: This endpoint looks up all ACCT and ACTM files and sub-directories
- in a given directory.
- operationId: getAccounts
+ /analytics/engines/afi/v3/optimizations:
+ post:
+ description: "This endpoint creates and runs AFI optimization specified in the\
+ \ POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\t\
+ Any settings in POST body will act as a one-time override over the settings\
+ \ saved in the strategy document."
+ operationId: postAndOptimize
parameters:
- - description: The directory to get the accounts and sub-directories in
+ - description: Long running deadline in seconds.
explode: false
- in: path
- name: path
- required: true
+ in: header
+ name: X-FactSet-Api-Long-Running-Deadline
+ required: false
+ schema:
+ type: integer
+ style: simple
+ - description: Standard HTTP header. Accepts max-stale.
+ explode: false
+ in: header
+ name: Cache-Control
+ required: false
schema:
- default: ""
- description: The directory to get the accounts and sub-directories in
type: string
style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AFIOptimizationParametersRoot'
+ description: Optimization Parameters
responses:
- "200":
+ "202":
content:
application/json:
schema:
- $ref: '#/components/schemas/AccountDirectoriesRoot'
- description: Expected response, returns a list of accounts and directories
+ $ref: '#/components/schemas/CalculationInfoRoot'
+ description: Expected response, contains the poll URL in the Location header.
headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ Location:
+ description: URL to poll for the resulting optimization
explode: false
schema:
+ description: URL to poll for the resulting optimization
type: string
style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid query parameter or value provided
- headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -425,12 +406,13 @@ paths:
schema:
type: string
style: simple
- "404":
+ "201":
content:
application/json:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Path not found
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response, returns json if optimization is completed
+ in a short span.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -466,27 +448,12 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
+ "400":
+ content:
+ application/json:
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid optimization parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -522,8 +489,12 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: One or more optimization settings were unavailable.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -559,55 +530,8 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in some time
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -625,59 +549,9 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get accounts and sub-directories in a directory
- tags:
- - Accounts
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: AccountDirectoriesRoot
- x-accepts: application/json
- /analytics/engines/afi/v3/optimizations:
- post:
- description: "This endpoint creates and runs AFI optimization specified in the\
- \ POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\t\
- Any settings in POST body will act as a one-time override over the settings\
- \ saved in the strategy document."
- operationId: postAndOptimize
- parameters:
- - description: Long running deadline in seconds.
- explode: false
- in: header
- name: X-FactSet-Api-Long-Running-Deadline
- required: false
- schema:
- type: integer
- style: simple
- - description: Standard HTTP header. Accepts max-stale.
- explode: false
- in: header
- name: Cache-Control
- required: false
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AFIOptimizationParametersRoot'
- description: Optimization Parameters
- responses:
- "202":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationInfoRoot'
- description: Expected response, contains the poll URL in the Location header.
+ "403":
+ description: User is forbidden with current credentials
headers:
- Location:
- description: URL to poll for the resulting optimization
- explode: false
- schema:
- description: URL to poll for the resulting optimization
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -712,189 +586,9 @@ paths:
schema:
type: string
style: simple
- "201":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response, returns json if optimization is completed
- in a short span.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid optimization parameters.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: One or more optimization settings were unavailable.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
+ "415":
+ description: Missing/Invalid Content-Type header. Header needs to be set
+ to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -4485,70 +4179,51 @@ paths:
- status-code: "200"
response-type: ObjectRoot
x-accepts: application/json
- /analytics/engines/spar/v3/benchmarks:
- get:
- description: This endpoint returns the details of a given SPAR benchmark identifier.
- operationId: getSPARBenchmarkById
+ /analytics/engines/bpm/v3/optimizations:
+ post:
+ description: "This endpoint creates and runs BPM optimization specified in the\
+ \ POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\t\
+ Any settings in POST body will act as a one-time override over the settings\
+ \ saved in the strategy document."
+ operationId: postAndOptimize
parameters:
- - description: Benchmark Identifier
- explode: true
- in: query
- name: id
- required: true
+ - description: Long running deadline in seconds.
+ explode: false
+ in: header
+ name: X-FactSet-Api-Long-Running-Deadline
+ required: false
+ schema:
+ type: integer
+ style: simple
+ - description: Standard HTTP header. Accepts max-stale.
+ explode: false
+ in: header
+ name: Cache-Control
+ required: false
schema:
- description: Benchmark Identifier
type: string
- style: form
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/BPMOptimizationParametersRoot'
+ description: Optimization Parameters
responses:
- "200":
+ "202":
content:
application/json:
schema:
- $ref: '#/components/schemas/SPARBenchmarkRoot'
- description: Expected response, returns the list of prefix and return types
- for the benchmark.
+ $ref: '#/components/schemas/CalculationInfoRoot'
+ description: Expected response, contains the poll URL in the Location header.
headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ Location:
+ description: URL to poll for the resulting optimization
explode: false
schema:
+ description: URL to poll for the resulting optimization
type: string
style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid benchmark identifier.
- headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -4583,300 +4258,13 @@ paths:
schema:
type: string
style: simple
- "404":
+ "201":
content:
application/json:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Benchmark identifier not found.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- summary: Get SPAR benchmark details
- tags:
- - Benchmarks
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: SPARBenchmarkRoot
- x-accepts: application/json
- /analytics/engines/bpm/v3/optimizations:
- post:
- description: "This endpoint creates and runs BPM optimization specified in the\
- \ POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\t\
- Any settings in POST body will act as a one-time override over the settings\
- \ saved in the strategy document."
- operationId: postAndOptimize
- parameters:
- - description: Long running deadline in seconds.
- explode: false
- in: header
- name: X-FactSet-Api-Long-Running-Deadline
- required: false
- schema:
- type: integer
- style: simple
- - description: Standard HTTP header. Accepts max-stale.
- explode: false
- in: header
- name: Cache-Control
- required: false
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/BPMOptimizationParametersRoot'
- description: Optimization Parameters
- responses:
- "202":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationInfoRoot'
- description: Expected response, contains the poll URL in the Location header.
- headers:
- Location:
- description: URL to poll for the resulting optimization
- explode: false
- schema:
- description: URL to poll for the resulting optimization
- type: string
- style: simple
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "201":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response, returns json if optimization is completed
- in a short span.
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response, returns json if optimization is completed
+ in a short span.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -6731,6 +6119,7 @@ paths:
schema:
default: ""
description: Column name
+ example: Security Name
type: string
style: form
- description: Column category
@@ -6751,6 +6140,7 @@ paths:
schema:
default: ""
description: The directory to get the columns in
+ example: Client
type: string
style: form
responses:
@@ -6983,6 +6373,7 @@ paths:
required: true
schema:
description: Unique identifier for a column
+ example: 2DBD317E3C235BC96E2FF8CA36CE036AF2F7F55525479B524AE78FD7D6BBC4A7
type: string
style: simple
responses:
@@ -7511,6 +6902,7 @@ paths:
required: true
schema:
description: Document Name
+ example: PA3_DOCUMENTS:DEFAULT
type: string
style: form
responses:
@@ -7816,6 +7208,7 @@ paths:
required: true
schema:
description: Unique identifier for a PA component
+ example: 801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46
type: string
style: simple
responses:
@@ -8109,11 +7502,11 @@ paths:
- status-code: "200"
response-type: PAComponentRoot
x-accepts: application/json
- /analytics/engines/spar/v3/components:
+ /analytics/engines/vault/v3/components:
get:
- description: This endpoint returns the list of SPAR components in a given SPAR
+ description: This endpoint returns the list of Vault components in a given Vault
document.
- operationId: getSPARComponents
+ operationId: getVaultComponents
parameters:
- description: Document Name
explode: true
@@ -8130,7 +7523,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ComponentSummaryRoot'
- description: Expected response, returns a list of SPAR components.
+ description: Expected response, returns a list of Vault components.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -8171,7 +7564,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid query parameter provided or Invalid SPAR document name.
+ description: Invalid query parameter provided or invalid Vault document
+ name.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -8212,7 +7606,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: SPAR Document not found.
+ description: Vault Document not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -8407,7 +7801,7 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get SPAR components
+ summary: Get Vault components
tags:
- Components
x-are-multiple-success-responses-different: false
@@ -8415,28 +7809,28 @@ paths:
- status-code: "200"
response-type: ComponentSummaryRoot
x-accepts: application/json
- /analytics/engines/vault/v3/components:
+ /analytics/engines/vault/v3/components/{id}:
get:
- description: This endpoint returns the list of Vault components in a given Vault
- document.
- operationId: getVaultComponents
+ description: This endpoint returns the default settings of a Vault component.
+ operationId: getVaultComponentById
parameters:
- - description: Document Name
- explode: true
- in: query
- name: document
+ - description: Unique identifier for a vault component
+ explode: false
+ in: path
+ name: id
required: true
schema:
- description: Document Name
+ description: Unique identifier for a vault component
type: string
- style: form
+ style: simple
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/ComponentSummaryRoot'
- description: Expected response, returns a list of Vault components.
+ $ref: '#/components/schemas/VaultComponentRoot'
+ description: Expected response, returns the default settings of a Vault
+ component.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -8477,8 +7871,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid query parameter provided or invalid Vault document
- name.
+ description: Invalid Vault component id.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -8519,7 +7912,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Vault Document not found.
+ description: Vault Component not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -8714,36 +8107,38 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Vault components
+ summary: Get Vault component by id
tags:
- Components
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: ComponentSummaryRoot
+ response-type: VaultComponentRoot
x-accepts: application/json
- /analytics/engines/vault/v3/components/{id}:
+ /analytics/engines/vault/v3/configurations:
get:
- description: This endpoint returns the default settings of a Vault component.
- operationId: getVaultComponentById
+ description: This endpoint returns all the Vault configurations saved in the
+ provided account.
+ operationId: getVaultConfigurations
parameters:
- - description: Unique identifier for a vault component
- explode: false
- in: path
- name: id
+ - description: Required account query parameter to filter configurations for
+ a specific account
+ explode: true
+ in: query
+ name: account
required: true
schema:
- description: Unique identifier for a vault component
+ description: Required account query parameter to filter configurations for
+ a specific account
type: string
- style: simple
+ style: form
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/VaultComponentRoot'
- description: Expected response, returns the default settings of a Vault
- component.
+ $ref: '#/components/schemas/VaultConfigurationSummaryRoot'
+ description: Expected response, returns a dictionary of Vault configurations.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -8784,7 +8179,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid Vault component id.
+ description: Invalid account.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -8825,7 +8220,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Vault Component not found.
+ description: Account not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -9020,38 +8415,36 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Vault component by id
+ summary: Get Vault configurations
tags:
- - Components
+ - Configurations
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: VaultComponentRoot
+ response-type: VaultConfigurationSummaryRoot
x-accepts: application/json
- /analytics/engines/vault/v3/configurations:
+ /analytics/engines/vault/v3/configurations/{id}:
get:
- description: This endpoint returns all the Vault configurations saved in the
- provided account.
- operationId: getVaultConfigurations
+ description: This endpoint returns details for a Vault configuration as well
+ as a list of accounts it is used in.
+ operationId: getVaultConfigurationById
parameters:
- - description: Required account query parameter to filter configurations for
- a specific account
- explode: true
- in: query
- name: account
+ - description: Vault configuration id to get the details of
+ explode: false
+ in: path
+ name: id
required: true
schema:
- description: Required account query parameter to filter configurations for
- a specific account
+ description: Vault configuration id to get the details of
type: string
- style: form
+ style: simple
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/VaultConfigurationSummaryRoot'
- description: Expected response, returns a dictionary of Vault configurations.
+ $ref: '#/components/schemas/VaultConfigurationRoot'
+ description: Expected response, returns details for a Vault configuration.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -9092,7 +8485,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid account.
+ description: Invalid vault configuration code.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -9133,7 +8526,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Account not found.
+ description: Vault configuration id not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -9328,36 +8721,26 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Vault configurations
+ summary: Get Vault configuration by id
tags:
- Configurations
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: VaultConfigurationSummaryRoot
+ response-type: VaultConfigurationRoot
x-accepts: application/json
- /analytics/engines/vault/v3/configurations/{id}:
+ /analytics/lookups/v3/currencies:
get:
- description: This endpoint returns details for a Vault configuration as well
- as a list of accounts it is used in.
- operationId: getVaultConfigurationById
- parameters:
- - description: Vault configuration id to get the details of
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: Vault configuration id to get the details of
- type: string
- style: simple
+ description: This endpoint lists all the currencies that can be applied to any
+ calculation.
+ operationId: getCurrencies
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/VaultConfigurationRoot'
- description: Expected response, returns details for a Vault configuration.
+ $ref: '#/components/schemas/CurrencyRoot'
+ description: Expected response, returns a list of currencies.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -9393,12 +8776,27 @@ paths:
schema:
type: string
style: simple
- "400":
- content:
- application/json:
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid vault configuration code.
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -9434,12 +8832,8 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Vault configuration id not found.
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -9475,8 +8869,9 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -9494,8 +8889,16 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -9513,26 +8916,89 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
+ summary: Get currencies
+ tags:
+ - Currencies
+ x-are-multiple-success-responses-different: false
+ x-success-response-types:
+ - status-code: "200"
+ response-type: CurrencyRoot
+ x-accepts: application/json
+ /analytics/engines/pa/v3/dates:
+ get:
+ description: This endpoint converts the given start and end dates in FactSet
+ date format to yyyymmdd format for a PA calculation. For more information
+ on FactSet date format, please refer to the PA Engine API documentation under
+ the 'API Documentation' section in the developer portal.
+ operationId: convertPADatesToAbsoluteFormat
+ parameters:
+ - description: Start Date
+ explode: true
+ in: query
+ name: startdate
+ required: false
+ schema:
+ description: Start Date
+ example: -3AY
+ type: string
+ style: form
+ - description: End Date
+ explode: true
+ in: query
+ name: enddate
+ required: true
+ schema:
+ description: End Date
+ example: -1AY
+ type: string
+ style: form
+ - description: Component Id
+ explode: true
+ in: query
+ name: componentid
+ required: true
+ schema:
+ description: Component Id
+ example: 801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46
+ type: string
+ style: form
+ - description: Account ( Should be in Format - AccountName.ACCT )
+ explode: true
+ in: query
+ name: account
+ required: true
+ schema:
+ description: Account ( Should be in Format - AccountName.ACCT )
+ example: Account Name
+ type: string
+ style: form
+ responses:
+ "200":
+ content:
+ application/json:
schema:
- type: string
- style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ $ref: '#/components/schemas/DateParametersSummaryRoot'
+ description: Expected response, returns the converted dates in yyyymmdd
+ format.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -9568,9 +9034,12 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid query parameter or value is provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -9588,72 +9057,30 @@ paths:
available after successful authentication.
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
- description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
type: string
style: simple
- summary: Get Vault configuration by id
- tags:
- - Configurations
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: VaultConfigurationRoot
- x-accepts: application/json
- /analytics/lookups/v3/currencies:
- get:
- description: This endpoint lists all the currencies that can be applied to any
- calculation.
- operationId: getCurrencies
- responses:
- "200":
+ "404":
content:
application/json:
schema:
- $ref: '#/components/schemas/CurrencyRoot'
- description: Expected response, returns a list of currencies.
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Document or account not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -9848,21 +9275,21 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get currencies
+ summary: Convert PA dates to absolute format
tags:
- - Currencies
+ - Dates
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: CurrencyRoot
+ response-type: DateParametersSummaryRoot
x-accepts: application/json
- /analytics/engines/pa/v3/dates:
+ /analytics/engines/vault/v3/dates:
get:
description: This endpoint converts the given start and end dates in FactSet
- date format to yyyymmdd format for a PA calculation. For more information
- on FactSet date format, please refer to the PA Engine API documentation under
+ date format to yyyymmdd format for a Vault calculation. For more information
+ on FactSet date format, please refer to the Vault API documentation under
the 'API Documentation' section in the developer portal.
- operationId: convertPADatesToAbsoluteFormat
+ operationId: convertVaultDatesToAbsoluteFormat
parameters:
- description: Start Date
explode: true
@@ -9882,13 +9309,13 @@ paths:
description: End Date
type: string
style: form
- - description: Component Id
+ - description: Vault Component Id
explode: true
in: query
name: componentid
required: true
schema:
- description: Component Id
+ description: Vault Component Id
type: string
style: form
- description: Account
@@ -9989,7 +9416,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Document or account not found.
+ description: vault Document or account not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -10184,7 +9611,7 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Convert PA dates to absolute format
+ summary: Convert Vault dates to absolute format
tags:
- Dates
x-are-multiple-success-responses-different: false
@@ -10192,48 +9619,17 @@ paths:
- status-code: "200"
response-type: DateParametersSummaryRoot
x-accepts: application/json
- /analytics/engines/vault/v3/dates:
+ /analytics/engines/fi/v3/discount-curves:
get:
- description: This endpoint converts the given start and end dates in FactSet
- date format to yyyymmdd format for a Vault calculation. For more information
- on FactSet date format, please refer to the Vault API documentation under
- the 'API Documentation' section in the developer portal.
- operationId: convertVaultDatesToAbsoluteFormat
+ description: This endpoint lists all the discount curves that can be applied
+ to a FI calculation.
+ operationId: getAllFIDiscountCurves
parameters:
- - description: Start Date
- explode: true
+ - explode: true
in: query
- name: startdate
+ name: currency
required: false
schema:
- description: Start Date
- type: string
- style: form
- - description: End Date
- explode: true
- in: query
- name: enddate
- required: true
- schema:
- description: End Date
- type: string
- style: form
- - description: Vault Component Id
- explode: true
- in: query
- name: componentid
- required: true
- schema:
- description: Vault Component Id
- type: string
- style: form
- - description: Account
- explode: true
- in: query
- name: account
- required: true
- schema:
- description: Account
type: string
style: form
responses:
@@ -10241,50 +9637,8 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/DateParametersSummaryRoot'
- description: Expected response, returns the converted dates in yyyymmdd
- format.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid query parameter or value is provided.
+ $ref: '#/components/schemas/FIDiscountCurveInfoRoot'
+ description: Expected response, returns a list of FI discount curves.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -10325,7 +9679,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: vault Document or account not found.
+ description: Not found
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -10520,34 +9874,79 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Convert Vault dates to absolute format
+ summary: Get Discount Curves
tags:
- - Dates
+ - DiscountCurves
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: DateParametersSummaryRoot
+ response-type: FIDiscountCurveInfoRoot
x-accepts: application/json
- /analytics/engines/fi/v3/discount-curves:
+ /analytics/engines/pa/v3/documents/{path}:
get:
- description: This endpoint lists all the discount curves that can be applied
- to a FI calculation.
- operationId: getAllFIDiscountCurves
+ description: This endpoint looks up all PA3 documents and sub-directories in
+ a given directory.
+ operationId: getPA3Documents
parameters:
- - explode: true
- in: query
- name: currency
- required: false
+ - description: The directory to get the documents and sub-directories in
+ explode: false
+ in: path
+ name: path
+ required: true
schema:
+ default: ""
+ description: The directory to get the documents and sub-directories in
+ example: 'Client:'
type: string
- style: form
+ style: simple
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/FIDiscountCurveInfoRoot'
- description: Expected response, returns a list of FI discount curves.
+ $ref: '#/components/schemas/DocumentDirectoriesRoot'
+ description: Expected response, returns a list of PA3 documents and directories
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid query parameter or value provided
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -10588,7 +9987,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Not found
+ description: Path not found
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -10625,7 +10024,7 @@ paths:
type: string
style: simple
"401":
- description: Missing or invalid authentication.
+ description: Missing or invalid authentication
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -10681,7 +10080,7 @@ paths:
type: string
style: simple
"406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ description: Unsupported Accept header. Header needs to be set to application/json
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -10746,7 +10145,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -10765,7 +10164,7 @@ paths:
type: string
style: simple
"503":
- description: Request timed out. Retry the request in sometime.
+ description: Request timed out. Retry the request in some time
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -10783,28 +10182,28 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Discount Curves
+ summary: Get PA3 documents and sub-directories in a directory
tags:
- - DiscountCurves
+ - Documents
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: FIDiscountCurveInfoRoot
+ response-type: DocumentDirectoriesRoot
x-accepts: application/json
- /analytics/engines/pa/v3/documents/{path}:
+ /analytics/engines/vault/v3/documents/{path}:
get:
- description: This endpoint looks up all PA3 documents and sub-directories in
- a given directory.
- operationId: getPA3Documents
+ description: This endpoint looks up all Vault documents and sub-directories
+ in a given directory.
+ operationId: getVaultDocuments
parameters:
- - description: The directory to get the documents and sub-directories in
+ - description: The directory to get the documents in
explode: false
in: path
name: path
required: true
schema:
default: ""
- description: The directory to get the documents and sub-directories in
+ description: The directory to get the documents in
type: string
style: simple
responses:
@@ -10813,7 +10212,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/DocumentDirectoriesRoot'
- description: Expected response, returns a list of PA3 documents and directories
+ description: Expected response, returns a list of Vault documents and directories
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -11090,7 +10489,7 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get PA3 documents and sub-directories in a directory
+ summary: Get Vault documents and sub-directories in a directory
tags:
- Documents
x-are-multiple-success-responses-different: false
@@ -11098,11 +10497,11 @@ paths:
- status-code: "200"
response-type: DocumentDirectoriesRoot
x-accepts: application/json
- /analytics/engines/vault/v3/documents/{path}:
+ /analytics/engines/pub/v3/documents/{path}:
get:
- description: This endpoint looks up all Vault documents and sub-directories
+ description: This endpoint looks up all Publisher documents and sub-directories
in a given directory.
- operationId: getVaultDocuments
+ operationId: getPubDocuments
parameters:
- description: The directory to get the documents in
explode: false
@@ -11120,7 +10519,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/DocumentDirectoriesRoot'
- description: Expected response, returns a list of Vault documents and directories
+ description: Expected response, returns a list of Publisher documents and
+ directories
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -11397,7 +10797,7 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Vault documents and sub-directories in a directory
+ summary: Gets Publisher documents and sub-directories in a directory
tags:
- Documents
x-are-multiple-success-responses-different: false
@@ -11405,111 +10805,19 @@ paths:
- status-code: "200"
response-type: DocumentDirectoriesRoot
x-accepts: application/json
- /analytics/engines/spar/v3/documents/{path}:
+ /analytics/engines/fiab/v1/calculations:
get:
- description: This endpoint looks up all SPAR3 documents and sub-directories
- in a given directory.
- operationId: getSPAR3Documents
- parameters:
- - description: The directory to get the documents in
- explode: false
- in: path
- name: path
- required: true
- schema:
- default: ""
- description: The directory to get the documents in
- type: string
- style: simple
+ description: This endpoints returns all FIAB calculation requests.
+ operationId: getCalculationStatusSummaries
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/DocumentDirectoriesRoot'
- description: Expected response, returns a list of SPAR3 documents and directories
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid query parameter or value provided
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Path not found
+ additionalProperties:
+ $ref: '#/components/schemas/FIABCalculationStatusSummary'
+ type: object
+ description: List of active FIAB calculation requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -11546,7 +10854,7 @@ paths:
type: string
style: simple
"401":
- description: Missing or invalid authentication
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -11565,7 +10873,7 @@ paths:
type: string
style: simple
"403":
- description: User is forbidden with current credentials
+ description: User is forbidden with current credentials.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -11602,7 +10910,7 @@ paths:
type: string
style: simple
"406":
- description: Unsupported Accept header. Header needs to be set to application/json
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -11667,7 +10975,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -11686,7 +10994,7 @@ paths:
type: string
style: simple
"503":
- description: Request timed out. Retry the request in some time
+ description: Request timed out. Retry the request in sometime.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -11704,39 +11012,37 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Gets SPAR3 documents and sub-directories in a directory
+ summary: Get all FIAB calculation summaries
tags:
- - Documents
+ - FIAB Calculations
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: DocumentDirectoriesRoot
x-accepts: application/json
- /analytics/engines/pub/v3/documents/{path}:
- get:
- description: This endpoint looks up all Publisher documents and sub-directories
- in a given directory.
- operationId: getPubDocuments
- parameters:
- - description: The directory to get the documents in
- explode: false
- in: path
- name: path
- required: true
- schema:
- default: ""
- description: The directory to get the documents in
- type: string
- style: simple
+ post:
+ description: "This endpoint creates a new FIAB calculation.\r\nThis must be\
+ \ used first before get status or cancelling endpoints with a calculation\
+ \ id.\r\nA successful response will contain the URL to check the status of\
+ \ the calculation request.\r\n\r\nRemarks:\r\n*\tAny settings in POST body\
+ \ will act as a one-time override over the settings saved in the FIAB template."
+ operationId: runCalculation
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FIABCalculationParameters'
responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DocumentDirectoriesRoot'
- description: Expected response, returns a list of Publisher documents and
- directories
+ "202":
+ description: Expected response, contains the URL in the Location header
+ to check the status of the calculation.
headers:
+ Location:
+ description: URL to check status of the request.
+ explode: false
+ schema:
+ description: URL to check status of the request.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -11753,6 +11059,21 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FIAB request limit.
+ explode: false
+ schema:
+ description: Maximum FIAB request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FIAB requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FIAB requests remaining till request limit
+ reached.
+ type: string
+ style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -11772,12 +11093,15 @@ paths:
type: string
style: simple
"400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid query parameter or value provided
+ description: Invalid POST body.
headers:
+ Location:
+ description: URL to check status of the request.
+ explode: false
+ schema:
+ description: URL to check status of the request.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -11794,6 +11118,21 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FIAB request limit.
+ explode: false
+ schema:
+ description: Maximum FIAB request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FIAB requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FIAB requests remaining till request limit
+ reached.
+ type: string
+ style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -11812,13 +11151,57 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ Location:
+ description: URL to check status of the request.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Path not found
+ description: URL to check status of the request.
+ type: string
+ style: simple
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FIAB request limit.
+ explode: false
+ schema:
+ description: Maximum FIAB request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FIAB requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FIAB requests remaining till request limit
+ reached.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials.
headers:
+ Location:
+ description: URL to check status of the request.
+ explode: false
+ schema:
+ description: URL to check status of the request.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -11835,6 +11218,21 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FIAB request limit.
+ explode: false
+ schema:
+ description: Maximum FIAB request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FIAB requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FIAB requests remaining till request limit
+ reached.
+ type: string
+ style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -11853,9 +11251,17 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication
+ "415":
+ description: Missing/Invalid Content-Type header. Header needs to be set
+ to application/json.
headers:
+ Location:
+ description: URL to check status of the request.
+ explode: false
+ schema:
+ description: URL to check status of the request.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -11872,23 +11278,19 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FIAB request limit.
explode: false
schema:
- description: FactSet's request key header.
+ description: Maximum FIAB request limit.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FIAB requests remaining till request limit reached.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ description: Number of FIAB requests remaining till request limit
+ reached.
type: string
style: simple
X-FactSet-Api-RateLimit-Limit:
@@ -11909,9 +11311,17 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json
+ "429":
+ description: Rate limit reached. Cancel older requests using Cancel FIAB
+ Calculation endpoint or wait for older requests to finish / expire.
headers:
+ Location:
+ description: URL to check status of the request.
+ explode: false
+ schema:
+ description: URL to check status of the request.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -11928,42 +11338,37 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FIAB request limit.
explode: false
schema:
+ description: Maximum FIAB request limit.
type: string
style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FIAB requests remaining till request limit reached.
explode: false
schema:
+ description: Number of FIAB requests remaining till request limit
+ reached.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
type: string
style: simple
Retry-After:
@@ -11975,8 +11380,15 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ in troubleshooting.
headers:
+ Location:
+ description: URL to check status of the request.
+ explode: false
+ schema:
+ description: URL to check status of the request.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -11993,9 +11405,31 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FIAB request limit.
+ explode: false
+ schema:
+ description: Maximum FIAB request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FIAB requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FIAB requests remaining till request limit
+ reached.
+ type: string
+ style: simple
"503":
- description: Request timed out. Retry the request in some time
+ description: Request timed out. Retry the request in sometime.
headers:
+ Location:
+ description: URL to check status of the request.
+ explode: false
+ schema:
+ description: URL to check status of the request.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -12012,28 +11446,80 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Gets Publisher documents and sub-directories in a directory
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FIAB request limit.
+ explode: false
+ schema:
+ description: Maximum FIAB request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FIAB requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FIAB requests remaining till request limit
+ reached.
+ type: string
+ style: simple
+ summary: Run FIAB calculation
tags:
- - Documents
+ - FIAB Calculations
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "200"
- response-type: DocumentDirectoriesRoot
+ - status-code: "202"
+ x-contentType: application/json
x-accepts: application/json
- /analytics/engines/fiab/v1/calculations:
+ /analytics/engines/fiab/v1/calculations/{id}:
get:
- description: This endpoints returns all FIAB calculation requests.
- operationId: getCalculationStatusSummaries
+ description: This is the endpoint to check on the progress of a previously requested
+ calculation.
+ operationId: getCalculationById
+ parameters:
+ - description: from url, provided from the location header in the Run FIAB Calculation
+ endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Run FIAB
+ Calculation endpoint
+ type: string
+ style: simple
responses:
"200":
content:
application/json:
schema:
- additionalProperties:
- $ref: '#/components/schemas/FIABCalculationStatusSummary'
- type: object
- description: List of active FIAB calculation requests.
+ $ref: '#/components/schemas/FIABCalculationStatus'
+ description: Expected response, returns status information of the entire
+ calculation if it is complete.
headers:
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ type: string
+ style: simple
+ Content-Type:
+ description: Standard HTTP header.
+ explode: false
+ schema:
+ description: Standard HTTP header.
+ type: string
+ style: simple
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -12068,9 +11554,23 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "202":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FIABCalculationStatus'
+ description: Expected response, returns status information of the entire
+ calculation if it is not complete.
headers:
+ Cache-Control:
+ description: Standard HTTP header. Header will specify max-age in seconds.
+ Polling can be adjusted based on the max-age value.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header will specify max-age in
+ seconds. Polling can be adjusted based on the max-age value.
+ type: integer
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -12087,8 +11587,26 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "400":
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -12124,8 +11642,27 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -12161,9 +11698,9 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
+ "404":
+ description: Calculation was already returned, provided id was not a requested
+ calculation, or the calculation was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -12181,16 +11718,27 @@ paths:
available after successful authentication.
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
type: string
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -12227,35 +11775,60 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get all FIAB calculation summaries
+ summary: Get FIAB calculation by id
tags:
- FIAB Calculations
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
+ response-type: FIABCalculationStatus
+ - status-code: "202"
+ response-type: FIABCalculationStatus
x-accepts: application/json
+ /analytics/engines/fi/v3/calculations:
post:
- description: "This endpoint creates a new FIAB calculation.\r\nThis must be\
- \ used first before get status or cancelling endpoints with a calculation\
- \ id.\r\nA successful response will contain the URL to check the status of\
- \ the calculation request.\r\n\r\nRemarks:\r\n*\tAny settings in POST body\
- \ will act as a one-time override over the settings saved in the FIAB template."
- operationId: runCalculation
+ description: This endpoint creates and runs a new FI calculation specified in
+ the post body.
+ operationId: postAndCalculate
+ parameters:
+ - description: Long running deadline in seconds.
+ explode: false
+ in: header
+ name: X-FactSet-Api-Long-Running-Deadline
+ required: false
+ schema:
+ type: integer
+ style: simple
+ - description: Standard HTTP header. Accepts max-stale.
+ explode: false
+ in: header
+ name: Cache-Control
+ required: false
+ schema:
+ type: string
+ style: simple
requestBody:
content:
application/json:
schema:
- $ref: '#/components/schemas/FIABCalculationParameters'
+ $ref: '#/components/schemas/FICalculationParametersRoot'
+ description: Calculation Parameters
responses:
"202":
- description: Expected response, contains the URL in the Location header
- to check the status of the calculation.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CalculationInfoRoot'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/CalculationInfoRoot'
+ description: Expected response, contains the poll URL in the Location header.
headers:
Location:
- description: URL to check status of the request.
+ description: URL to poll for the resulting calculation
explode: false
schema:
- description: URL to check status of the request.
+ description: URL to poll for the resulting calculation
type: string
style: simple
X-DataDirect-Request-Key:
@@ -12275,18 +11848,17 @@ paths:
type: string
style: simple
X-FactSet-Api-Calculations-Limit:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
explode: false
schema:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
type: string
style: simple
X-FactSet-Api-Calculations-Remaining:
- description: Number of FIAB requests remaining till request limit reached.
+ description: Number of FI requests remaining till request limit reached.
explode: false
schema:
- description: Number of FIAB requests remaining till request limit
- reached.
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
X-FactSet-Api-RateLimit-Limit:
@@ -12307,16 +11879,17 @@ paths:
schema:
type: string
style: simple
- "400":
- description: Invalid POST body.
- headers:
- Location:
- description: URL to check status of the request.
- explode: false
+ "201":
+ content:
+ application/json:
schema:
- description: URL to check status of the request.
- type: string
- style: simple
+ $ref: '#/components/schemas/ObjectRoot'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response if calculation is completed in a short span,
+ returns JSON in the format specified in the Calculation parameters.
+ headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -12334,18 +11907,17 @@ paths:
type: string
style: simple
X-FactSet-Api-Calculations-Limit:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
explode: false
schema:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
type: string
style: simple
X-FactSet-Api-Calculations-Remaining:
- description: Number of FIAB requests remaining till request limit reached.
+ description: Number of FI requests remaining till request limit reached.
explode: false
schema:
- description: Number of FIAB requests remaining till request limit
- reached.
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
X-FactSet-Api-RateLimit-Limit:
@@ -12366,16 +11938,16 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- Location:
- description: URL to check status of the request.
- explode: false
+ "400":
+ content:
+ application/json:
schema:
- description: URL to check status of the request.
- type: string
- style: simple
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid calculation parameters.
+ headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -12393,30 +11965,47 @@ paths:
type: string
style: simple
X-FactSet-Api-Calculations-Limit:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
explode: false
schema:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
type: string
style: simple
X-FactSet-Api-Calculations-Remaining:
- description: Number of FIAB requests remaining till request limit reached.
+ description: Number of FI requests remaining till request limit reached.
explode: false
schema:
- description: Number of FIAB requests remaining till request limit
- reached.
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials.
- headers:
- Location:
- description: URL to check status of the request.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
- description: URL to check status of the request.
type: string
style: simple
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: One or more calculation settings were unavailable.
+ headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -12434,18 +12023,17 @@ paths:
type: string
style: simple
X-FactSet-Api-Calculations-Limit:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
explode: false
schema:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
type: string
style: simple
X-FactSet-Api-Calculations-Remaining:
- description: Number of FIAB requests remaining till request limit reached.
+ description: Number of FI requests remaining till request limit reached.
explode: false
schema:
- description: Number of FIAB requests remaining till request limit
- reached.
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
X-FactSet-Api-RateLimit-Limit:
@@ -12466,17 +12054,42 @@ paths:
schema:
type: string
style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
+ "401":
+ description: Missing or invalid authentication.
headers:
- Location:
- description: URL to check status of the request.
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
- description: URL to check status of the request.
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
+ explode: false
+ schema:
+ description: Maximum FI request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
+ "403":
+ description: User is forbidden with current credentials
+ headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -12494,18 +12107,17 @@ paths:
type: string
style: simple
X-FactSet-Api-Calculations-Limit:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
explode: false
schema:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
type: string
style: simple
X-FactSet-Api-Calculations-Remaining:
- description: Number of FIAB requests remaining till request limit reached.
+ description: Number of FI requests remaining till request limit reached.
explode: false
schema:
- description: Number of FIAB requests remaining till request limit
- reached.
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
X-FactSet-Api-RateLimit-Limit:
@@ -12526,17 +12138,10 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Cancel older requests using Cancel FIAB
- Calculation endpoint or wait for older requests to finish / expire.
+ "415":
+ description: Missing/Invalid Content-Type header. Header needs to be set
+ to application/json.
headers:
- Location:
- description: URL to check status of the request.
- explode: false
- schema:
- description: URL to check status of the request.
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -12554,18 +12159,17 @@ paths:
type: string
style: simple
X-FactSet-Api-Calculations-Limit:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
explode: false
schema:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
type: string
style: simple
X-FactSet-Api-Calculations-Remaining:
- description: Number of FIAB requests remaining till request limit reached.
+ description: Number of FI requests remaining till request limit reached.
explode: false
schema:
- description: Number of FIAB requests remaining till request limit
- reached.
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
X-FactSet-Api-RateLimit-Limit:
@@ -12586,24 +12190,10 @@ paths:
schema:
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ "429":
+ description: Rate limit reached. Cancel older requests using Cancel Calculation
+ endpoint or wait for older requests to finish/expire.
headers:
- Location:
- description: URL to check status of the request.
- explode: false
- schema:
- description: URL to check status of the request.
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -12621,511 +12211,10 @@ paths:
type: string
style: simple
X-FactSet-Api-Calculations-Limit:
- description: Maximum FIAB request limit.
+ description: Maximum FI request limit.
explode: false
schema:
- description: Maximum FIAB request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FIAB requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FIAB requests remaining till request limit
- reached.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- Location:
- description: URL to check status of the request.
- explode: false
- schema:
- description: URL to check status of the request.
- type: string
- style: simple
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FIAB request limit.
- explode: false
- schema:
- description: Maximum FIAB request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FIAB requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FIAB requests remaining till request limit
- reached.
- type: string
- style: simple
- summary: Run FIAB calculation
- tags:
- - FIAB Calculations
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "202"
- x-contentType: application/json
- x-accepts: application/json
- /analytics/engines/fiab/v1/calculations/{id}:
- get:
- description: This is the endpoint to check on the progress of a previously requested
- calculation.
- operationId: getCalculationById
- parameters:
- - description: from url, provided from the location header in the Run FIAB Calculation
- endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Run FIAB
- Calculation endpoint
- type: string
- style: simple
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/FIABCalculationStatus'
- description: Expected response, returns status information of the entire
- calculation if it is complete.
- headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
- explode: false
- schema:
- description: Standard HTTP header.
- type: string
- style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- explode: false
- schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- type: string
- style: simple
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "202":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/FIABCalculationStatus'
- description: Expected response, returns status information of the entire
- calculation if it is not complete.
- headers:
- Cache-Control:
- description: Standard HTTP header. Header will specify max-age in seconds.
- Polling can be adjusted based on the max-age value.
- explode: false
- schema:
- description: Standard HTTP header. Header will specify max-age in
- seconds. Polling can be adjusted based on the max-age value.
- type: integer
- style: simple
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "400":
- description: Invalid identifier provided.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "404":
- description: Calculation was already returned, provided id was not a requested
- calculation, or the calculation was cancelled
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- summary: Get FIAB calculation by id
- tags:
- - FIAB Calculations
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: FIABCalculationStatus
- - status-code: "202"
- response-type: FIABCalculationStatus
- x-accepts: application/json
- /analytics/engines/fi/v3/calculations:
- post:
- description: This endpoint creates and runs a new FI calculation specified in
- the post body.
- operationId: postAndCalculate
- parameters:
- - description: Long running deadline in seconds.
- explode: false
- in: header
- name: X-FactSet-Api-Long-Running-Deadline
- required: false
- schema:
- type: integer
- style: simple
- - description: Standard HTTP header. Accepts max-stale.
- explode: false
- in: header
- name: Cache-Control
- required: false
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/FICalculationParametersRoot'
- description: Calculation Parameters
- responses:
- "202":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationInfoRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/CalculationInfoRoot'
- description: Expected response, contains the poll URL in the Location header.
- headers:
- Location:
- description: URL to poll for the resulting calculation
- explode: false
- schema:
- description: URL to poll for the resulting calculation
- type: string
- style: simple
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "201":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response if calculation is completed in a short span,
- returns JSON in the format specified in the Calculation parameters.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
+ description: Maximum FI request limit.
type: string
style: simple
X-FactSet-Api-Calculations-Remaining:
@@ -13153,1279 +12242,16 @@ paths:
schema:
type: string
style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid calculation parameters.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: One or more calculation settings were unavailable.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "429":
- description: Rate limit reached. Cancel older requests using Cancel Calculation
- endpoint or wait for older requests to finish/expire.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
- summary: Create and Run FI calculation
- tags:
- - FICalculations
- x-are-multiple-success-responses-different: true
- x-success-response-types:
- - status-code: "202"
- response-type: CalculationInfoRoot
- - status-code: "201"
- response-type: ObjectRoot
- x-contentType: application/json
- x-accepts: application/json
- /analytics/engines/fi/v3/calculations/{id}:
- delete:
- description: This is the endpoint to cancel a previously submitted calculation.
- operationId: cancelCalculationById
- parameters:
- - description: from url, provided from the location header in the Create and
- Run FI calculation endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Create and
- Run FI calculation endpoint
- type: string
- style: simple
- responses:
- "204":
- description: Expected response, calculation was canceled successfully.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "400":
- content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "404":
- content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: There was no request for the calculation identifier provided,
- or the request was already canceled for the provided identifier.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- summary: Cancel FI calculation by id
- tags:
- - FICalculations
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "204"
- x-accepts: application/json
- get:
- description: This is the endpoint that returns the calculation parameters passed
- for a calculation.
- operationId: getCalculationParameters
- parameters:
- - description: from url, provided from the location header in the Create and
- Run FI calculation endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Create and
- Run FI calculation endpoint
- type: string
- style: simple
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/FICalculationParametersRoot'
- description: Expected response, returns the FI calculation parameters.
- headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
- explode: false
- schema:
- description: Standard HTTP header.
- type: string
- style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- explode: false
- schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- type: string
- style: simple
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation id not found
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- summary: Get FI calculation parameters by id
- tags:
- - FICalculations
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: FICalculationParametersRoot
- x-accepts: application/json
- put:
- description: This endpoint updates and run the FI optimization specified in
- the PUT body parameters. It also allows the creation of new FI optimization
- with custom id.
- operationId: putAndCalculate
- parameters:
- - description: from url, provided from the location header in the Create and
- Run FI calculation endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Create and
- Run FI calculation endpoint
- type: string
- style: simple
- - description: Long running deadline in seconds.
- explode: false
- in: header
- name: X-FactSet-Api-Long-Running-Deadline
- required: false
- schema:
- type: integer
- style: simple
- - description: Standard HTTP header. Accepts max-stale.
- explode: false
- in: header
- name: Cache-Control
- required: false
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/FICalculationParametersRoot'
- description: Calculation Parameters
- responses:
- "202":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationInfoRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/CalculationInfoRoot'
- description: Expected response, contains the poll URL in the Location header.
- headers:
- Location:
- description: URL to poll for the resulting calculation
- explode: false
- schema:
- description: URL to poll for the resulting calculation
- type: string
- style: simple
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "201":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response if calculation is completed in a short span,
- returns JSON in the format specified in the Calculation parameters.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid Calculation Parameters.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: One or more calculation settings were unavailable.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "409":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Duplicate calculation exists with same parameters.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
explode: false
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Cancel older requests using Cancel Calculation
- endpoint or wait for older requests to finish/expire.
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -14443,34 +12269,22 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
explode: false
schema:
+ description: Maximum FI request limit.
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
explode: false
schema:
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ "503":
+ description: Request timed out. Retry the request in sometime.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -14488,26 +12302,21 @@ paths:
available after successful authentication.
type: string
style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
explode: false
schema:
- description: FactSet's request key header.
+ description: Maximum FI request limit.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
- summary: Create or Update FI calculation and run it.
+ summary: Create and Run FI calculation
tags:
- FICalculations
x-are-multiple-success-responses-different: true
@@ -14518,14 +12327,10 @@ paths:
response-type: ObjectRoot
x-contentType: application/json
x-accepts: application/json
- /analytics/engines/fi/v3/calculations/{id}/status:
- get:
- description: "This is the endpoint to check on the progress of a previously\
- \ requested calculation.\r\nIf the calculation has finished computing, the\
- \ body of the response will contain the requested document in JSON.\r\nOtherwise,\
- \ the calculation is still running and the X-FactSet-Api-PickUp-Progress header\
- \ will contain a progress percentage."
- operationId: getCalculationStatusById
+ /analytics/engines/fi/v3/calculations/{id}:
+ delete:
+ description: This is the endpoint to cancel a previously submitted calculation.
+ operationId: cancelCalculationById
parameters:
- description: from url, provided from the location header in the Create and
Run FI calculation endpoint
@@ -14539,71 +12344,9 @@ paths:
type: string
style: simple
responses:
- "201":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response once calculation is completed, returns JSON
- in the format specified in the Calculation parameters.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "202":
- description: Expected response returned if the calculation is not yet completed,
- should contain X-FactSet-Api-PickUp-Progress header.
+ "204":
+ description: Expected response, calculation was canceled successfully.
headers:
- X-FactSet-Api-PickUp-Progress:
- description: FactSet's progress header.
- explode: false
- schema:
- description: FactSet's progress header.
- type: string
- style: simple
- Cache-Control:
- description: Standard HTTP header. Header will specify max-age in seconds.
- Polling can be adjusted based on the max-age value.
- explode: false
- schema:
- description: Standard HTTP header. Header will specify max-age in
- seconds. Polling can be adjusted based on the max-age value.
- type: integer
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -14640,10 +12383,13 @@ paths:
style: simple
"400":
content:
+ text/plain:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
+ text/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
description: Invalid identifier provided.
@@ -14684,14 +12430,17 @@ paths:
style: simple
"404":
content:
+ text/plain:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
+ text/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation was already returned, provided id was not a requested
- calculation, or the calculation was cancelled
+ description: There was no request for the calculation identifier provided,
+ or the request was already canceled for the provided identifier.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -14785,7 +12534,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -14822,31 +12571,27 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get FI calculation status by id
+ summary: Cancel FI calculation by id
tags:
- FICalculations
- x-are-multiple-success-responses-different: true
+ x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "201"
- response-type: ObjectRoot
- - status-code: "202"
+ - status-code: "204"
x-accepts: application/json
- /analytics/engines/fi/v3/calculations/{id}/result:
get:
- description: "This is the endpoint to get the result of a previously requested\
- \ calculation.\r\nIf the calculation has finished computing, the body of the\
- \ response will contain the requested document in JSON."
- operationId: getCalculationResult
+ description: This is the endpoint that returns the calculation parameters passed
+ for a calculation.
+ operationId: getCalculationParameters
parameters:
- - description: from url, provided from the location header in the Get FI calculation
- status by id endpoint
+ - description: from url, provided from the location header in the Create and
+ Run FI calculation endpoint
explode: false
in: path
name: id
required: true
schema:
- description: from url, provided from the location header in the Get FI calculation
- status by id endpoint
+ description: from url, provided from the location header in the Create and
+ Run FI calculation endpoint
type: string
style: simple
responses:
@@ -14854,12 +12599,8 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ObjectRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response once calculation is completed, returns JSON
- in the format specified in the Calculation parameters.
+ $ref: '#/components/schemas/FICalculationParametersRoot'
+ description: Expected response, returns the FI calculation parameters.
headers:
Content-Encoding:
description: Standard HTTP header. Header value based on Accept-Encoding
@@ -14925,9 +12666,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
@@ -14969,11 +12707,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation was already returned, provided id was not a requested
- calculation, or the calculation was cancelled
+ description: Calculation id not found
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -15104,22 +12838,31 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get FI calculation result by id
+ summary: Get FI calculation parameters by id
tags:
- FICalculations
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: ObjectRoot
+ response-type: FICalculationParametersRoot
x-accepts: application/json
- /analytics/engines/fpo/v3/optimizations:
- post:
- description: "This endpoint runs FPO optimization specified in the POST body\
- \ parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings\
- \ in POST body will act as a one-time override over the settings saved in\
- \ the strategy document."
- operationId: postAndOptimize
+ put:
+ description: This endpoint updates and run the FI optimization specified in
+ the PUT body parameters. It also allows the creation of new FI optimization
+ with custom id.
+ operationId: putAndCalculate
parameters:
+ - description: from url, provided from the location header in the Create and
+ Run FI calculation endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Create and
+ Run FI calculation endpoint
+ type: string
+ style: simple
- description: Long running deadline in seconds.
explode: false
in: header
@@ -15140,23 +12883,71 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/FPOOptimizationParametersRoot'
- description: Optimization Parameters
+ $ref: '#/components/schemas/FICalculationParametersRoot'
+ description: Calculation Parameters
responses:
"202":
content:
application/json:
schema:
$ref: '#/components/schemas/CalculationInfoRoot'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/CalculationInfoRoot'
description: Expected response, contains the poll URL in the Location header.
headers:
Location:
- description: URL to poll for the resulting optimization
+ description: URL to poll for the resulting calculation
+ explode: false
+ schema:
+ description: URL to poll for the resulting calculation
+ type: string
+ style: simple
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
- description: URL to poll for the resulting optimization
type: string
style: simple
+ "201":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ObjectRoot'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response if calculation is completed in a short span,
+ returns JSON in the format specified in the Calculation parameters.
+ headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -15191,13 +12982,15 @@ paths:
schema:
type: string
style: simple
- "201":
+ "400":
content:
application/json:
schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response, returns json if optimization is completed
- in a short span.
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid Calculation Parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -15233,12 +13026,15 @@ paths:
schema:
type: string
style: simple
- "400":
+ "404":
content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid optimization parameters.
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: One or more calculation settings were unavailable.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -15274,12 +13070,15 @@ paths:
schema:
type: string
style: simple
- "404":
+ "409":
content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: One or more optimization settings were unavailable.
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Duplicate calculation exists with same parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -15410,7 +13209,7 @@ paths:
type: string
style: simple
"429":
- description: Rate limit reached. Cancel older requests using Cancel optimization
+ description: Rate limit reached. Cancel older requests using Cancel Calculation
endpoint or wait for older requests to finish/expire.
headers:
X-DataDirect-Request-Key:
@@ -15493,9 +13292,9 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create and Run FPO optimization
+ summary: Create or Update FI calculation and run it.
tags:
- - FPO Optimizer
+ - FICalculations
x-are-multiple-success-responses-different: true
x-success-response-types:
- status-code: "202"
@@ -15504,176 +13303,37 @@ paths:
response-type: ObjectRoot
x-contentType: application/json
x-accepts: application/json
- /analytics/engines/fpo/v3/optimizations/{id}:
- delete:
- description: This is the endpoint to cancel a previously submitted optimization.
- operationId: cancelOptimizationById
+ /analytics/engines/fi/v3/calculations/{id}/status:
+ get:
+ description: "This is the endpoint to check on the progress of a previously\
+ \ requested calculation.\r\nIf the calculation has finished computing, the\
+ \ body of the response will contain the requested document in JSON.\r\nOtherwise,\
+ \ the calculation is still running and the X-FactSet-Api-PickUp-Progress header\
+ \ will contain a progress percentage."
+ operationId: getCalculationStatusById
parameters:
- description: from url, provided from the location header in the Create and
- Run FPO optimization endpoint
+ Run FI calculation endpoint
explode: false
in: path
name: id
required: true
schema:
description: from url, provided from the location header in the Create and
- Run FPO optimization endpoint
+ Run FI calculation endpoint
type: string
style: simple
responses:
- "204":
- description: Expected response, optimization was canceled successfully.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "400":
- content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "404":
+ "201":
content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: There was no request for the optimization identifier provided,
- or the request was already canceled for the provided identifier.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
+ $ref: '#/components/schemas/ObjectRoot'
+ application/x-protobuf:
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response once calculation is completed, returns JSON
+ in the format specified in the Calculation parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -15709,100 +13369,25 @@ paths:
schema:
type: string
style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- summary: Cancel FPO optimization by id
- tags:
- - FPO Optimizer
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "204"
- x-accepts: application/json
- get:
- description: This is the endpoint that returns the optimization parameters passed
- for an optimization.
- operationId: getOptimizationParameters
- parameters:
- - description: from url, provided from the location header in the Create and
- Run FPO optimization endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Create and
- Run FPO optimization endpoint
- type: string
- style: simple
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/FPOOptimizationParametersRoot'
- description: Expected response, returns the FPO optimization parameters.
+ "202":
+ description: Expected response returned if the calculation is not yet completed,
+ should contain X-FactSet-Api-PickUp-Progress header.
headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
+ X-FactSet-Api-PickUp-Progress:
+ description: FactSet's progress header.
explode: false
schema:
- description: Standard HTTP header.
+ description: FactSet's progress header.
type: string
style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
+ Cache-Control:
+ description: Standard HTTP header. Header will specify max-age in seconds.
+ Polling can be adjusted based on the max-age value.
explode: false
schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- type: string
+ description: Standard HTTP header. Header will specify max-age in
+ seconds. Polling can be adjusted based on the max-age value.
+ type: integer
style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -15843,6 +13428,9 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
@@ -15884,7 +13472,11 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Optimization id not found
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Calculation was already returned, provided id was not a requested
+ calculation, or the calculation was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -16015,192 +13607,70 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get FPO optimization parameters by id
+ summary: Get FI calculation status by id
tags:
- - FPO Optimizer
- x-are-multiple-success-responses-different: false
+ - FICalculations
+ x-are-multiple-success-responses-different: true
x-success-response-types:
- - status-code: "200"
- response-type: FPOOptimizationParametersRoot
+ - status-code: "201"
+ response-type: ObjectRoot
+ - status-code: "202"
x-accepts: application/json
- put:
- description: This endpoint updates and run the FPO optimization specified in
- the PUT body parameters. It also allows the creation of new FPO optimization
- with custom id.
- operationId: putAndOptimize
+ /analytics/engines/fi/v3/calculations/{id}/result:
+ get:
+ description: "This is the endpoint to get the result of a previously requested\
+ \ calculation.\r\nIf the calculation has finished computing, the body of the\
+ \ response will contain the requested document in JSON."
+ operationId: getCalculationResult
parameters:
- - description: from url, provided from the location header in the Create and
- Run FPO optimization endpoint
+ - description: from url, provided from the location header in the Get FI calculation
+ status by id endpoint
explode: false
in: path
name: id
required: true
schema:
- description: from url, provided from the location header in the Create and
- Run FPO optimization endpoint
- type: string
- style: simple
- - description: Long running deadline in seconds.
- explode: false
- in: header
- name: X-FactSet-Api-Long-Running-Deadline
- required: false
- schema:
- type: integer
- style: simple
- - description: Standard HTTP header. Accepts max-stale.
- explode: false
- in: header
- name: Cache-Control
- required: false
- schema:
+ description: from url, provided from the location header in the Get FI calculation
+ status by id endpoint
type: string
style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/FPOOptimizationParametersRoot'
- description: Optimization Parameters
responses:
- "202":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationInfoRoot'
- description: Expected response, contains the poll URL in the Location header.
- headers:
- Location:
- description: URL to poll for the resulting optimization
- explode: false
- schema:
- description: URL to poll for the resulting optimization
- type: string
- style: simple
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "201":
+ "200":
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectRoot'
- description: Expected response, returns json if optimization is completed
- in a short span.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "400":
- content:
- application/json:
+ application/x-protobuf:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid Optimization Parameters.
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response once calculation is completed, returns JSON
+ in the format specified in the Calculation parameters.
headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
explode: false
schema:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ Content-Type:
+ description: Standard HTTP header.
explode: false
schema:
+ description: Standard HTTP header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
explode: false
schema:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
type: string
style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: One or more optimization settings were unavailable.
- headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -16235,12 +13705,15 @@ paths:
schema:
type: string
style: simple
- "409":
+ "400":
content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Duplicate optimization exists with same parameters.
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -16276,27 +13749,16 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
+ "404":
+ content:
+ application/json:
schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/x-protobuf:
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Calculation was already returned, provided id was not a requested
+ calculation, or the calculation was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -16332,9 +13794,8 @@ paths:
schema:
type: string
style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -16352,27 +13813,8 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "429":
- description: Rate limit reached. Cancel older requests using Cancel optimization
- endpoint or wait for older requests to finish/expire.
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -16408,16 +13850,9 @@ paths:
schema:
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
- schema:
- type: string
- style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -16454,45 +13889,59 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create or Update FPO optimization and run it.
+ summary: Get FI calculation result by id
tags:
- - FPO Optimizer
- x-are-multiple-success-responses-different: true
+ - FICalculations
+ x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "202"
- response-type: CalculationInfoRoot
- - status-code: "201"
+ - status-code: "200"
response-type: ObjectRoot
- x-contentType: application/json
x-accepts: application/json
- /analytics/engines/fpo/v3/optimizations/{id}/status:
- get:
- description: "This is the endpoint to check on the progress of a previously\
- \ requested optimization.\r\nIf the optimization has finished computing, the\
- \ body of the response will contain result in JSON.\r\nOtherwise, the optimization\
- \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\
- \ a progress percentage."
- operationId: getOptimizationStatusById
+ /analytics/engines/fpo/v3/optimizations:
+ post:
+ description: "This endpoint runs FPO optimization specified in the POST body\
+ \ parameters.\r\n \r\nRemarks:\r\n \r\n*\tAny settings\
+ \ in POST body will act as a one-time override over the settings saved in\
+ \ the strategy document."
+ operationId: postAndOptimize
parameters:
- - description: from url, provided from the location header in the Create and
- Run FPO optimization endpoint
+ - description: Long running deadline in seconds.
explode: false
- in: path
- name: id
- required: true
+ in: header
+ name: X-FactSet-Api-Long-Running-Deadline
+ required: false
+ schema:
+ type: integer
+ style: simple
+ - description: Standard HTTP header. Accepts max-stale.
+ explode: false
+ in: header
+ name: Cache-Control
+ required: false
schema:
- description: from url, provided from the location header in the Create and
- Run FPO optimization endpoint
type: string
style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FPOOptimizationParametersRoot'
+ description: Optimization Parameters
responses:
- "201":
+ "202":
content:
application/json:
schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response once optimization is completed, returns JSON.
+ $ref: '#/components/schemas/CalculationInfoRoot'
+ description: Expected response, contains the poll URL in the Location header.
headers:
+ Location:
+ description: URL to poll for the resulting optimization
+ explode: false
+ schema:
+ description: URL to poll for the resulting optimization
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -16527,26 +13976,14 @@ paths:
schema:
type: string
style: simple
- "202":
- description: Expected response returned if the optimization is not yet completed,
- should contain X-FactSet-Api-PickUp-Progress header.
- headers:
- X-FactSet-Api-PickUp-Progress:
- description: FactSet's progress header.
- explode: false
- schema:
- description: FactSet's progress header.
- type: string
- style: simple
- Cache-Control:
- description: Standard HTTP header. Header will specify max-age in seconds.
- Polling can be adjusted based on the max-age value.
- explode: false
+ "201":
+ content:
+ application/json:
schema:
- description: Standard HTTP header. Header will specify max-age in
- seconds. Polling can be adjusted based on the max-age value.
- type: integer
- style: simple
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response, returns json if optimization is completed
+ in a short span.
+ headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -16586,7 +14023,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ description: Invalid optimization parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -16627,8 +14064,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Optimization result was already returned, provided id was not
- a requested optimization, or the optimization was cancelled
+ description: One or more optimization settings were unavailable.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -16720,9 +14156,92 @@ paths:
schema:
type: string
style: simple
+ "415":
+ description: Missing/Invalid Content-Type header. Header needs to be set
+ to application/json.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "429":
+ description: Rate limit reached. Cancel older requests using Cancel optimization
+ endpoint or wait for older requests to finish/expire.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
+ explode: false
+ schema:
+ type: string
+ style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -16759,75 +14278,37 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get FPO optimization status by id
+ summary: Create and Run FPO optimization
tags:
- FPO Optimizer
x-are-multiple-success-responses-different: true
x-success-response-types:
+ - status-code: "202"
+ response-type: CalculationInfoRoot
- status-code: "201"
response-type: ObjectRoot
- - status-code: "202"
+ x-contentType: application/json
x-accepts: application/json
- /analytics/engines/fpo/v3/optimizations/{id}/result:
- get:
- description: "This is the endpoint to get the result of a previously requested\
- \ optimization.\r\nIf the optimization has finished computing, the body of\
- \ the response will contain result in JSON."
- operationId: getOptimizationResult
+ /analytics/engines/fpo/v3/optimizations/{id}:
+ delete:
+ description: This is the endpoint to cancel a previously submitted optimization.
+ operationId: cancelOptimizationById
parameters:
- - description: from url, provided from the location header in the Get FPO optimization
- status by id endpoint
+ - description: from url, provided from the location header in the Create and
+ Run FPO optimization endpoint
explode: false
in: path
name: id
required: true
schema:
- description: from url, provided from the location header in the Get FPO
- optimization status by id endpoint
- type: string
- style: simple
- - description: Standard HTTP header. Value can be gzip, compress, deflate, br,
- identity and/or *
- explode: false
- in: header
- name: Accept
- required: false
- schema:
+ description: from url, provided from the location header in the Create and
+ Run FPO optimization endpoint
type: string
style: simple
responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response once optimization is completed, returns JSON.
+ "204":
+ description: Expected response, optimization was canceled successfully.
headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
- explode: false
- schema:
- description: Standard HTTP header.
- type: string
- style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- explode: false
- schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -16864,9 +14345,15 @@ paths:
style: simple
"400":
content:
+ text/plain:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
+ text/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
@@ -16905,11 +14392,17 @@ paths:
style: simple
"404":
content:
+ text/plain:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Optimization result was already returned, provided id was not
- a requested optimization, or the optimization was cancelled
+ text/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: There was no request for the optimization identifier provided,
+ or the request was already canceled for the provided identifier.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17003,7 +14496,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17040,27 +14533,62 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get FPO optimization result by id
+ summary: Cancel FPO optimization by id
tags:
- FPO Optimizer
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "200"
- response-type: ObjectRoot
+ - status-code: "204"
x-accepts: application/json
- /analytics/engines/pa/v3/frequencies:
get:
- description: This endpoint lists all the frequencies that can be applied to
- a PA calculation.
- operationId: getPAFrequencies
+ description: This is the endpoint that returns the optimization parameters passed
+ for an optimization.
+ operationId: getOptimizationParameters
+ parameters:
+ - description: from url, provided from the location header in the Create and
+ Run FPO optimization endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Create and
+ Run FPO optimization endpoint
+ type: string
+ style: simple
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/FrequencyRoot'
- description: Expected response, returns a list of PA frequencies.
+ $ref: '#/components/schemas/FPOOptimizationParametersRoot'
+ description: Expected response, returns the FPO optimization parameters.
headers:
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ type: string
+ style: simple
+ Content-Type:
+ description: Standard HTTP header.
+ explode: false
+ schema:
+ description: Standard HTTP header.
+ type: string
+ style: simple
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -17095,27 +14623,12 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
+ "400":
+ content:
+ application/json:
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17151,8 +14664,12 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Optimization id not found
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17188,9 +14705,8 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17208,16 +14724,46 @@ paths:
available after successful authentication.
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
+ "403":
+ description: User is forbidden with current credentials
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
type: string
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17254,27 +14800,68 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get PA frequencies
+ summary: Get FPO optimization parameters by id
tags:
- - Frequencies
+ - FPO Optimizer
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: FrequencyRoot
+ response-type: FPOOptimizationParametersRoot
x-accepts: application/json
- /analytics/engines/spar/v3/frequencies:
- get:
- description: This endpoint lists all the frequencies that can be applied to
- a SPAR calculation.
- operationId: getSPARFrequencies
+ put:
+ description: This endpoint updates and run the FPO optimization specified in
+ the PUT body parameters. It also allows the creation of new FPO optimization
+ with custom id.
+ operationId: putAndOptimize
+ parameters:
+ - description: from url, provided from the location header in the Create and
+ Run FPO optimization endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Create and
+ Run FPO optimization endpoint
+ type: string
+ style: simple
+ - description: Long running deadline in seconds.
+ explode: false
+ in: header
+ name: X-FactSet-Api-Long-Running-Deadline
+ required: false
+ schema:
+ type: integer
+ style: simple
+ - description: Standard HTTP header. Accepts max-stale.
+ explode: false
+ in: header
+ name: Cache-Control
+ required: false
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FPOOptimizationParametersRoot'
+ description: Optimization Parameters
responses:
- "200":
+ "202":
content:
application/json:
schema:
- $ref: '#/components/schemas/FrequencyRoot'
- description: Expected response, returns a list of SPAR frequencies.
+ $ref: '#/components/schemas/CalculationInfoRoot'
+ description: Expected response, contains the poll URL in the Location header.
headers:
+ Location:
+ description: URL to poll for the resulting optimization
+ explode: false
+ schema:
+ description: URL to poll for the resulting optimization
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -17309,27 +14896,13 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
+ "201":
+ content:
+ application/json:
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response, returns json if optimization is completed
+ in a short span.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17365,8 +14938,12 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid Optimization Parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17394,44 +14971,20 @@ paths:
description: Number of requests left for the time window.
explode: false
schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
type: string
style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: One or more optimization settings were unavailable.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17449,45 +15002,30 @@ paths:
available after successful authentication.
type: string
style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
- description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
type: string
style: simple
- summary: Get SPAR frequencies
- tags:
- - Frequencies
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: FrequencyRoot
- x-accepts: application/json
- /analytics/engines/vault/v3/frequencies:
- get:
- description: This endpoint lists all the frequencies that can be applied to
- a Vault calculation.
- operationId: getVaultFrequencies
- responses:
- "200":
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "409":
content:
application/json:
schema:
- $ref: '#/components/schemas/FrequencyRoot'
- description: Expected response, returns a list of Vault frequencies.
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Duplicate optimization exists with same parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17579,8 +15117,9 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ "415":
+ description: Missing/Invalid Content-Type header. Header needs to be set
+ to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17617,8 +15156,8 @@ paths:
type: string
style: simple
"429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
+ description: Rate limit reached. Cancel older requests using Cancel optimization
+ endpoint or wait for older requests to finish/expire.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17636,6 +15175,24 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
Retry-After:
description: Time to wait in seconds before making a new request as
the rate limit has reached.
@@ -17682,26 +15239,44 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Vault frequencies
+ summary: Create or Update FPO optimization and run it.
tags:
- - Frequencies
- x-are-multiple-success-responses-different: false
+ - FPO Optimizer
+ x-are-multiple-success-responses-different: true
x-success-response-types:
- - status-code: "200"
- response-type: FrequencyRoot
+ - status-code: "202"
+ response-type: CalculationInfoRoot
+ - status-code: "201"
+ response-type: ObjectRoot
+ x-contentType: application/json
x-accepts: application/json
- /analytics/engines/pa/v3/groups:
+ /analytics/engines/fpo/v3/optimizations/{id}/status:
get:
- description: This endpoint lists all the PA groups that can be applied to a
- PA calculation.
- operationId: getPAGroups
+ description: "This is the endpoint to check on the progress of a previously\
+ \ requested optimization.\r\nIf the optimization has finished computing, the\
+ \ body of the response will contain result in JSON.\r\nOtherwise, the optimization\
+ \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\
+ \ a progress percentage."
+ operationId: getOptimizationStatusById
+ parameters:
+ - description: from url, provided from the location header in the Create and
+ Run FPO optimization endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Create and
+ Run FPO optimization endpoint
+ type: string
+ style: simple
responses:
- "200":
+ "201":
content:
application/json:
schema:
- $ref: '#/components/schemas/GroupRoot'
- description: Expected response, returns a list of PA groups
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response once optimization is completed, returns JSON.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17719,15 +15294,6 @@ paths:
available after successful authentication.
type: string
style: simple
- Age:
- description: Standard HTTP header. Header will specify the age of groupings
- list cached response.
- explode: false
- schema:
- description: Standard HTTP header. Header will specify the age of
- groupings list cached response.
- type: integer
- style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -17746,9 +15312,26 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "202":
+ description: Expected response returned if the optimization is not yet completed,
+ should contain X-FactSet-Api-PickUp-Progress header.
headers:
+ X-FactSet-Api-PickUp-Progress:
+ description: FactSet's progress header.
+ explode: false
+ schema:
+ description: FactSet's progress header.
+ type: string
+ style: simple
+ Cache-Control:
+ description: Standard HTTP header. Header will specify max-age in seconds.
+ Polling can be adjusted based on the max-age value.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header will specify max-age in
+ seconds. Polling can be adjusted based on the max-age value.
+ type: integer
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -17765,8 +15348,30 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17802,8 +15407,13 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Optimization result was already returned, provided id was not
+ a requested optimization, or the optimization was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17839,9 +15449,8 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -17859,9 +15468,39 @@ paths:
available after successful authentication.
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
+ "403":
+ description: User is forbidden with current credentials
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
type: string
@@ -17905,27 +15544,75 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get PA groups
+ summary: Get FPO optimization status by id
tags:
- - Groups
- x-are-multiple-success-responses-different: false
+ - FPO Optimizer
+ x-are-multiple-success-responses-different: true
x-success-response-types:
- - status-code: "200"
- response-type: GroupRoot
+ - status-code: "201"
+ response-type: ObjectRoot
+ - status-code: "202"
x-accepts: application/json
- /analytics/engines/pa/v3/grouping-frequencies:
+ /analytics/engines/fpo/v3/optimizations/{id}/result:
get:
- description: This endpoint lists all the PA grouping frequencies that can be
- applied to a PA calculation.
- operationId: getPAGroupingFrequencies
+ description: "This is the endpoint to get the result of a previously requested\
+ \ optimization.\r\nIf the optimization has finished computing, the body of\
+ \ the response will contain result in JSON."
+ operationId: getOptimizationResult
+ parameters:
+ - description: from url, provided from the location header in the Get FPO optimization
+ status by id endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Get FPO
+ optimization status by id endpoint
+ type: string
+ style: simple
+ - description: Standard HTTP header. Value can be gzip, compress, deflate, br,
+ identity and/or *
+ explode: false
+ in: header
+ name: Accept
+ required: false
+ schema:
+ type: string
+ style: simple
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/FrequencyRoot'
- description: Expected response, returns a list of PA grouping frequencies
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response once optimization is completed, returns JSON.
headers:
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ type: string
+ style: simple
+ Content-Type:
+ description: Standard HTTP header.
+ explode: false
+ schema:
+ description: Standard HTTP header.
+ type: string
+ style: simple
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -17960,27 +15647,12 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
+ "400":
+ content:
+ application/json:
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18016,8 +15688,13 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Optimization result was already returned, provided id was not
+ a requested optimization, or the optimization was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18053,9 +15730,8 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18073,9 +15749,39 @@ paths:
available after successful authentication.
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
+ "403":
+ description: User is forbidden with current credentials
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
type: string
@@ -18119,55 +15825,26 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get PA grouping frequencies
+ summary: Get FPO optimization result by id
tags:
- - Groups
+ - FPO Optimizer
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: FrequencyRoot
+ response-type: ObjectRoot
x-accepts: application/json
- /analytics/engines/pa/v3/linked-templates:
+ /analytics/engines/pa/v3/frequencies:
get:
- description: This endpoint returns the list of linked PA templates in given
- path.
- operationId: getLinkedPATemplates
- parameters:
- - description: Get linked PA templates in path.
- explode: true
- in: query
- name: directory
- required: false
- schema:
- description: Get linked PA templates in path.
- type: string
- style: form
- - description: Get linked PA templates for documents in document path
- explode: true
- in: query
- name: documentDirectory
- required: false
- schema:
- description: Get linked PA templates for documents in document path
- type: string
- style: form
- - description: Get linked PA templates for documents by document name
- explode: true
- in: query
- name: documentName
- required: false
- schema:
- description: Get linked PA templates for documents by document name
- type: string
- style: form
+ description: This endpoint lists all the frequencies that can be applied to
+ a PA calculation.
+ operationId: getPAFrequencies
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/LinkedPATemplateSummaryRoot'
- description: Expected response, returns a list of templates linked to PA3
- tile.
+ $ref: '#/components/schemas/FrequencyRoot'
+ description: Expected response, returns a list of PA frequencies.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18203,13 +15880,27 @@ paths:
schema:
type: string
style: simple
- "400":
- content:
- application/json:
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid data provided. Please check the request parameters
- before attempting again.
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18245,12 +15936,8 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Document not found
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18286,8 +15973,9 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18305,8 +15993,16 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18324,26 +16020,45 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
+ summary: Get PA frequencies
+ tags:
+ - Frequencies
+ x-are-multiple-success-responses-different: false
+ x-success-response-types:
+ - status-code: "200"
+ response-type: FrequencyRoot
+ x-accepts: application/json
+ /analytics/engines/vault/v3/frequencies:
+ get:
+ description: This endpoint lists all the frequencies that can be applied to
+ a Vault calculation.
+ operationId: getVaultFrequencies
+ responses:
+ "200":
+ content:
+ application/json:
schema:
- type: string
- style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ $ref: '#/components/schemas/FrequencyRoot'
+ description: Expected response, returns a list of Vault frequencies.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18379,9 +16094,8 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18399,16 +16113,8 @@ paths:
available after successful authentication.
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18426,60 +16132,26 @@ paths:
available after successful authentication.
type: string
style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
- description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
type: string
style: simple
- summary: Get linked PA templates
- tags:
- - LinkedPATemplates
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: LinkedPATemplateSummaryRoot
- x-accepts: application/json
- post:
- description: "This endpoint creates a template from an **existing portfolio\
- \ analysis tile**, allowing the user to replicate and fetch reports settings.\r\
- \n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST\
- \ requests and Optional fields are not necessary. \r\n If no mandatory\
- \ fields are passed, then we can use the template as a component and skip\
- \ the component creation.\r\n \r\n* Mandatory, optional and locked fields\
- \ can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\"\
- , \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot\
- \ override the Locked fields when creating the Component.\r\n\r\n* Mandatory\
- \ and locked strings are mutually exclusive.\r\n\r\n* Multi-horizon frequencies\
- \ are not supported through this endpoint."
- operationId: createLinkedPATemplates
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/LinkedPATemplateParametersRoot'
- description: Request Parameters
- required: true
- responses:
- "201":
- content:
- application/json:
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
schema:
- $ref: '#/components/schemas/LinkedPATemplatePostSummaryRoot'
- description: Expected response, created a template linked to a PA3 tile.
+ type: string
+ style: simple
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18515,13 +16187,9 @@ paths:
schema:
type: string
style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid data provided. Please check the request parameters
- before attempting again.
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18539,26 +16207,35 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
explode: false
schema:
type: string
style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "503":
+ description: Request timed out. Retry the request in sometime.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18576,8 +16253,26 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
+ summary: Get Vault frequencies
+ tags:
+ - Frequencies
+ x-are-multiple-success-responses-different: false
+ x-success-response-types:
+ - status-code: "200"
+ response-type: FrequencyRoot
+ x-accepts: application/json
+ /analytics/engines/pa/v3/groups:
+ get:
+ description: This endpoint lists all the PA groups that can be applied to a
+ PA calculation.
+ operationId: getPAGroups
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GroupRoot'
+ description: Expected response, returns a list of PA groups
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18595,6 +16290,15 @@ paths:
available after successful authentication.
type: string
style: simple
+ Age:
+ description: Standard HTTP header. Header will specify the age of groupings
+ list cached response.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header will specify the age of
+ groupings list cached response.
+ type: integer
+ style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -18613,8 +16317,27 @@ paths:
schema:
type: string
style: simple
- "404":
- description: Component not found.
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18716,7 +16439,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -18753,127 +16476,26 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create a linked PA template
+ summary: Get PA groups
tags:
- - LinkedPATemplates
+ - Groups
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "201"
- response-type: LinkedPATemplatePostSummaryRoot
- x-contentType: application/json
+ - status-code: "200"
+ response-type: GroupRoot
x-accepts: application/json
- /analytics/engines/pa/v3/linked-templates/{id}:
- delete:
- description: This endpoint deletes an existing linked PA template.
- operationId: deleteLinkedPATemplates
- parameters:
- - description: Unique identifier for a linked PA template
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: Unique identifier for a linked PA template
- type: string
- style: simple
+ /analytics/engines/pa/v3/grouping-frequencies:
+ get:
+ description: This endpoint lists all the PA grouping frequencies that can be
+ applied to a PA calculation.
+ operationId: getPAGroupingFrequencies
responses:
- "204":
- description: Expected response, deleted the linked PA template successfully.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "400":
- content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid data provided. Please check the request parameters
- before attempting again.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "404":
+ "200":
content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Template not found.
+ $ref: '#/components/schemas/FrequencyRoot'
+ description: Expected response, returns a list of PA grouping frequencies
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -19031,7 +16653,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -19068,33 +16690,56 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Delete a linked PA template.
+ summary: Get PA grouping frequencies
tags:
- - LinkedPATemplates
+ - Groups
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "204"
+ - status-code: "200"
+ response-type: FrequencyRoot
x-accepts: application/json
+ /analytics/engines/pa/v3/linked-templates:
get:
- description: This endpoint fetches the linked PA template settings.
- operationId: getLinkedPATemplatesById
+ description: This endpoint returns the list of linked PA templates in given
+ path.
+ operationId: getLinkedPATemplates
parameters:
- - description: Unique identifier for a linked PA template
- explode: false
- in: path
- name: id
- required: true
+ - description: Get linked PA templates in path.
+ explode: true
+ in: query
+ name: directory
+ required: false
schema:
- description: Unique identifier for a linked PA template
+ description: Get linked PA templates in path.
+ example: Personal:LinkedPATemplates/
type: string
- style: simple
+ style: form
+ - description: Get linked PA templates for documents in document path
+ explode: true
+ in: query
+ name: documentDirectory
+ required: false
+ schema:
+ description: Get linked PA templates for documents in document path
+ type: string
+ style: form
+ - description: Get linked PA templates for documents by document name
+ explode: true
+ in: query
+ name: documentName
+ required: false
+ schema:
+ description: Get linked PA templates for documents by document name
+ type: string
+ style: form
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/LinkedPATemplateRoot'
- description: Expected response, linked PA template details.
+ $ref: '#/components/schemas/LinkedPATemplateSummaryRoot'
+ description: Expected response, returns a list of templates linked to PA3
+ tile.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -19177,7 +16822,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Template not found.
+ description: Document not found
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -19372,50 +17017,41 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get linked PA template by id
+ summary: Get linked PA templates
tags:
- LinkedPATemplates
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: LinkedPATemplateRoot
+ response-type: LinkedPATemplateSummaryRoot
x-accepts: application/json
- put:
- description: "This endpoint allows the user to change the request body and description\
- \ from an existing template.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are\
- \ required to be passed in POST requests and Optional fields are not necessary.\
- \ \r\n If no mandatory fields are passed, then we can use the template\
- \ as a component and skip the component creation.\r\n \r\n* Mandatory,\
- \ optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\"\
- , \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\"\
- .\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\
- \n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* \
- \ Multi-horizon frequencies are not supported through this endpoint."
- operationId: updateLinkedPATemplates
- parameters:
- - description: Unique identifier for a linked PA template
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: Unique identifier for a linked PA template
- type: string
- style: simple
+ post:
+ description: "This endpoint creates a template from an **existing portfolio\
+ \ analysis tile**, allowing the user to replicate and fetch reports settings.\r\
+ \n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be passed in POST\
+ \ requests and Optional fields are not necessary. \r\n If no mandatory\
+ \ fields are passed, then we can use the template as a component and skip\
+ \ the component creation.\r\n \r\n* Mandatory, optional and locked fields\
+ \ can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\"\
+ , \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot\
+ \ override the Locked fields when creating the Component.\r\n\r\n* Mandatory\
+ \ and locked strings are mutually exclusive.\r\n\r\n* Multi-horizon frequencies\
+ \ are not supported through this endpoint."
+ operationId: createLinkedPATemplates
requestBody:
content:
application/json:
schema:
- $ref: '#/components/schemas/LinkedPATemplateUpdateParametersRoot'
+ $ref: '#/components/schemas/LinkedPATemplateParametersRoot'
description: Request Parameters
required: true
responses:
- "200":
+ "201":
content:
application/json:
schema:
$ref: '#/components/schemas/LinkedPATemplatePostSummaryRoot'
- description: Expected response, updated a template linked to a PA3 tile.
+ description: Expected response, created a template linked to a PA3 tile.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -19493,12 +17129,8 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Template or component not found.
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -19516,45 +17148,45 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
+ "403":
+ description: User is forbidden with current credentials
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
+ "404":
+ description: Component not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -19693,101 +17325,33 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Update a linked PA template
+ summary: Create a linked PA template
tags:
- LinkedPATemplates
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "200"
+ - status-code: "201"
response-type: LinkedPATemplatePostSummaryRoot
x-contentType: application/json
x-accepts: application/json
- /analytics/engines/npo/v3/optimizations:
- post:
- description: "This endpoint creates and runs NPO optimization specified in the\
- \ POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\t\
- Any settings in POST body will act as a one-time override over the settings\
- \ saved in the strategy document."
- operationId: postAndOptimize
+ /analytics/engines/pa/v3/linked-templates/{id}:
+ delete:
+ description: This endpoint deletes an existing linked PA template.
+ operationId: deleteLinkedPATemplates
parameters:
- - description: Long running deadline in seconds.
- explode: false
- in: header
- name: X-FactSet-Api-Long-Running-Deadline
- required: false
- schema:
- type: integer
- style: simple
- - description: Standard HTTP header. Accepts max-stale.
+ - description: Unique identifier for a linked PA template
explode: false
- in: header
- name: Cache-Control
- required: false
+ in: path
+ name: id
+ required: true
schema:
+ description: Unique identifier for a linked PA template
+ example: "01234567890123456789012345678901"
type: string
style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/NPOOptimizationParametersRoot'
- description: Optimization Parameters
responses:
- "202":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationInfoRoot'
- description: Expected response, contains the poll URL in the Location header.
- headers:
- Location:
- description: URL to poll for the resulting optimization
- explode: false
- schema:
- description: URL to poll for the resulting optimization
- type: string
- style: simple
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "201":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response, returns json if optimization is completed
- in a short span.
+ "204":
+ description: Expected response, deleted the linked PA template successfully.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -19825,10 +17389,17 @@ paths:
style: simple
"400":
content:
+ text/plain:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid optimization parameters.
+ text/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid data provided. Please check the request parameters
+ before attempting again.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -19866,10 +17437,16 @@ paths:
style: simple
"404":
content:
+ text/plain:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: One or more optimization settings were unavailable.
+ text/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Template not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -19961,47 +17538,8 @@ paths:
schema:
type: string
style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "429":
- description: Rate limit reached. Cancel older requests using Cancel optimization
- endpoint or wait for older requests to finish/expire.
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -20037,6 +17575,26 @@ paths:
schema:
type: string
style: simple
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
Retry-After:
description: Time to wait in seconds before making a new request as
the rate limit has reached.
@@ -20083,36 +17641,34 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create and Run NPO optimization
+ summary: Delete a linked PA template.
tags:
- - NPO Optimizer
- x-are-multiple-success-responses-different: true
+ - LinkedPATemplates
+ x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "202"
- response-type: CalculationInfoRoot
- - status-code: "201"
- response-type: ObjectRoot
- x-contentType: application/json
+ - status-code: "204"
x-accepts: application/json
- /analytics/engines/npo/v3/optimizations/{id}:
- delete:
- description: This is the endpoint to cancel a previously submitted optimization.
- operationId: cancelOptimizationById
+ get:
+ description: This endpoint fetches the linked PA template settings.
+ operationId: getLinkedPATemplatesById
parameters:
- - description: from url, provided from the location header in the Create and
- Run NPO optimization endpoint
+ - description: Unique identifier for a linked PA template
explode: false
in: path
name: id
required: true
schema:
- description: from url, provided from the location header in the Create and
- Run NPO optimization endpoint
+ description: Unique identifier for a linked PA template
+ example: "01234567890123456789012345678901"
type: string
style: simple
responses:
- "204":
- description: Expected response, optimization was canceled successfully.
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/LinkedPATemplateRoot'
+ description: Expected response, linked PA template details.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -20150,16 +17706,11 @@ paths:
style: simple
"400":
content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ description: Invalid data provided. Please check the request parameters
+ before attempting again.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -20197,17 +17748,10 @@ paths:
style: simple
"404":
content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: There was no request for the optimization identifier provided,
- or the request was already canceled for the provided identifier.
+ description: Template not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -20299,6 +17843,70 @@ paths:
schema:
type: string
style: simple
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
+ explode: false
+ schema:
+ type: string
+ style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
in troubleshooting.
@@ -20338,62 +17946,52 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Cancel NPO optimization by id
+ summary: Get linked PA template by id
tags:
- - NPO Optimizer
+ - LinkedPATemplates
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "204"
+ - status-code: "200"
+ response-type: LinkedPATemplateRoot
x-accepts: application/json
- get:
- description: This is the endpoint that returns the optimization parameters passed
- for an optimization.
- operationId: getOptimizationParameters
+ put:
+ description: "This endpoint allows the user to change the request body and description\
+ \ from an existing template.\r\n\r\nRemarks:\r\n\r\n* Mandatory fields are\
+ \ required to be passed in POST requests and Optional fields are not necessary.\
+ \ \r\n If no mandatory fields are passed, then we can use the template\
+ \ as a component and skip the component creation.\r\n \r\n* Mandatory,\
+ \ optional and locked fields can be \"accounts\", \"benchmarks\", \"groups\"\
+ , \"columns\", \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\"\
+ .\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\
+ \n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* \
+ \ Multi-horizon frequencies are not supported through this endpoint."
+ operationId: updateLinkedPATemplates
parameters:
- - description: from url, provided from the location header in the Create and
- Run NPO optimization endpoint
+ - description: Unique identifier for a linked PA template
explode: false
in: path
name: id
required: true
schema:
- description: from url, provided from the location header in the Create and
- Run NPO optimization endpoint
+ description: Unique identifier for a linked PA template
+ example: "01234567890123456789012345678901"
type: string
style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/LinkedPATemplateUpdateParametersRoot'
+ description: Request Parameters
+ required: true
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/NPOOptimizationParametersRoot'
- description: Expected response, returns the NPO optimization parameters.
+ $ref: '#/components/schemas/LinkedPATemplatePostSummaryRoot'
+ description: Expected response, updated a template linked to a PA3 tile.
headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
- explode: false
- schema:
- description: Standard HTTP header.
- type: string
- style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- explode: false
- schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -20433,7 +18031,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ description: Invalid data provided. Please check the request parameters
+ before attempting again.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -20474,7 +18073,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Optimization id not found
+ description: Template or component not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -20566,107 +18165,9 @@ paths:
schema:
type: string
style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- summary: Get NPO optimization parameters by id
- tags:
- - NPO Optimizer
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: NPOOptimizationParametersRoot
- x-accepts: application/json
- put:
- description: This endpoint updates and run the NPO optimization specified in
- the PUT body parameters. It also allows the creation of new NPO optimization
- with custom id.
- operationId: putAndOptimize
- parameters:
- - description: from url, provided from the location header in the Create and
- Run NPO optimization endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Create and
- Run NPO optimization endpoint
- type: string
- style: simple
- - description: Long running deadline in seconds.
- explode: false
- in: header
- name: X-FactSet-Api-Long-Running-Deadline
- required: false
- schema:
- type: integer
- style: simple
- - description: Standard HTTP header. Accepts max-stale.
- explode: false
- in: header
- name: Cache-Control
- required: false
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/NPOOptimizationParametersRoot'
- description: Optimization Parameters
- responses:
- "202":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationInfoRoot'
- description: Expected response, contains the poll URL in the Location header.
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
- Location:
- description: URL to poll for the resulting optimization
- explode: false
- schema:
- description: URL to poll for the resulting optimization
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -20701,14 +18202,126 @@ paths:
schema:
type: string
style: simple
- "201":
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ summary: Update a linked PA template
+ tags:
+ - LinkedPATemplates
+ x-are-multiple-success-responses-different: false
+ x-success-response-types:
+ - status-code: "200"
+ response-type: LinkedPATemplatePostSummaryRoot
+ x-contentType: application/json
+ x-accepts: application/json
+ /analytics/engines/npo/v3/optimizations:
+ post:
+ description: "This endpoint creates and runs NPO optimization specified in the\
+ \ POST body parameters.\r\n \r\nRemarks:\r\n \r\n*\t\
+ Any settings in POST body will act as a one-time override over the settings\
+ \ saved in the strategy document."
+ operationId: postAndOptimize
+ parameters:
+ - description: Long running deadline in seconds.
+ explode: false
+ in: header
+ name: X-FactSet-Api-Long-Running-Deadline
+ required: false
+ schema:
+ type: integer
+ style: simple
+ - description: Standard HTTP header. Accepts max-stale.
+ explode: false
+ in: header
+ name: Cache-Control
+ required: false
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NPOOptimizationParametersRoot'
+ description: Optimization Parameters
+ responses:
+ "202":
content:
application/json:
schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response, returns json if optimization is completed
- in a short span.
+ $ref: '#/components/schemas/CalculationInfoRoot'
+ description: Expected response, contains the poll URL in the Location header.
headers:
+ Location:
+ description: URL to poll for the resulting optimization
+ explode: false
+ schema:
+ description: URL to poll for the resulting optimization
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -20743,12 +18356,13 @@ paths:
schema:
type: string
style: simple
- "400":
+ "201":
content:
application/json:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid Optimization Parameters.
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response, returns json if optimization is completed
+ in a short span.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -20784,12 +18398,12 @@ paths:
schema:
type: string
style: simple
- "404":
+ "400":
content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: One or more optimization settings were unavailable.
+ description: Invalid optimization parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -20825,12 +18439,12 @@ paths:
schema:
type: string
style: simple
- "409":
+ "404":
content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Duplicate optimization exists with same parameters.
+ description: One or more optimization settings were unavailable.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -21044,7 +18658,7 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create or Update NPO optimization and run it.
+ summary: Create and Run NPO optimization
tags:
- NPO Optimizer
x-are-multiple-success-responses-different: true
@@ -21055,14 +18669,10 @@ paths:
response-type: ObjectRoot
x-contentType: application/json
x-accepts: application/json
- /analytics/engines/npo/v3/optimizations/{id}/status:
- get:
- description: "This is the endpoint to check on the progress of a previously\
- \ requested optimization.\r\nIf the optimization has finished computing, the\
- \ body of the response will contain result in JSON.\r\nOtherwise, the optimization\
- \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\
- \ a progress percentage."
- operationId: getOptimizationStatusById
+ /analytics/engines/npo/v3/optimizations/{id}:
+ delete:
+ description: This is the endpoint to cancel a previously submitted optimization.
+ operationId: cancelOptimizationById
parameters:
- description: from url, provided from the location header in the Create and
Run NPO optimization endpoint
@@ -21076,12 +18686,8 @@ paths:
type: string
style: simple
responses:
- "201":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response once optimization is completed, returns JSON.
+ "204":
+ description: Expected response, optimization was canceled successfully.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -21117,65 +18723,17 @@ paths:
schema:
type: string
style: simple
- "202":
- description: Expected response returned if the optimization is not yet completed,
- should contain X-FactSet-Api-PickUp-Progress header.
- headers:
- X-FactSet-Api-PickUp-Progress:
- description: FactSet's progress header.
- explode: false
- schema:
- description: FactSet's progress header.
- type: string
- style: simple
- Cache-Control:
- description: Standard HTTP header. Header will specify max-age in seconds.
- Polling can be adjusted based on the max-age value.
- explode: false
- schema:
- description: Standard HTTP header. Header will specify max-age in
- seconds. Polling can be adjusted based on the max-age value.
- type: integer
- style: simple
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
"400":
content:
+ text/plain:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
+ text/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
@@ -21214,11 +18772,17 @@ paths:
style: simple
"404":
content:
+ text/plain:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Optimization result was already returned, provided id was not
- a requested optimization, or the optimization was cancelled
+ text/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: There was no request for the optimization identifier provided,
+ or the request was already canceled for the provided identifier.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -21312,7 +18876,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -21349,30 +18913,27 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get NPO optimization status by id
+ summary: Cancel NPO optimization by id
tags:
- NPO Optimizer
- x-are-multiple-success-responses-different: true
+ x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "201"
- response-type: ObjectRoot
- - status-code: "202"
+ - status-code: "204"
x-accepts: application/json
- /analytics/engines/npo/v3/optimizations/{id}/result:
get:
- description: This is the endpoint to get the result of a previously requested
- optimization.
- operationId: getOptimizationResult
+ description: This is the endpoint that returns the optimization parameters passed
+ for an optimization.
+ operationId: getOptimizationParameters
parameters:
- - description: from url, provided from the location header in the Get NPO optimization
- status by id endpoint
+ - description: from url, provided from the location header in the Create and
+ Run NPO optimization endpoint
explode: false
in: path
name: id
required: true
schema:
- description: from url, provided from the location header in the Get NPO
- optimization status by id endpoint
+ description: from url, provided from the location header in the Create and
+ Run NPO optimization endpoint
type: string
style: simple
responses:
@@ -21380,8 +18941,8 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response once optimization is completed, returns JSON.
+ $ref: '#/components/schemas/NPOOptimizationParametersRoot'
+ description: Expected response, returns the NPO optimization parameters.
headers:
Content-Encoding:
description: Standard HTTP header. Header value based on Accept-Encoding
@@ -21488,8 +19049,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Optimization result was already returned, provided id was not
- a requested optimization, or the optimization was cancelled
+ description: Optimization id not found
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -21620,36 +19180,68 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get NPO optimization result by id
+ summary: Get NPO optimization parameters by id
tags:
- NPO Optimizer
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: ObjectRoot
+ response-type: NPOOptimizationParametersRoot
x-accepts: application/json
- /analytics/engines/pa/v3/calculations:
- get:
- description: This endpoints returns all calculation requests.
- operationId: getAllCalculations
+ put:
+ description: This endpoint updates and run the NPO optimization specified in
+ the PUT body parameters. It also allows the creation of new NPO optimization
+ with custom id.
+ operationId: putAndOptimize
parameters:
- - explode: true
- in: query
- name: pageNumber
+ - description: from url, provided from the location header in the Create and
+ Run NPO optimization endpoint
+ explode: false
+ in: path
+ name: id
required: true
schema:
- default: 1
- format: int32
+ description: from url, provided from the location header in the Create and
+ Run NPO optimization endpoint
+ type: string
+ style: simple
+ - description: Long running deadline in seconds.
+ explode: false
+ in: header
+ name: X-FactSet-Api-Long-Running-Deadline
+ required: false
+ schema:
type: integer
- style: form
+ style: simple
+ - description: Standard HTTP header. Accepts max-stale.
+ explode: false
+ in: header
+ name: Cache-Control
+ required: false
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NPOOptimizationParametersRoot'
+ description: Optimization Parameters
responses:
- "200":
+ "202":
content:
application/json:
schema:
- $ref: '#/components/schemas/CalculationsSummaryRoot'
- description: List of calculation requests.
+ $ref: '#/components/schemas/CalculationInfoRoot'
+ description: Expected response, contains the poll URL in the Location header.
headers:
+ Location:
+ description: URL to poll for the resulting optimization
+ explode: false
+ schema:
+ description: URL to poll for the resulting optimization
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -21684,12 +19276,13 @@ paths:
schema:
type: string
style: simple
- "400":
+ "201":
content:
application/json:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid page number.
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response, returns json if optimization is completed
+ in a short span.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -21725,12 +19318,12 @@ paths:
schema:
type: string
style: simple
- "404":
+ "400":
content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: No calculation found.
+ description: Invalid Optimization Parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -21766,27 +19359,12 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
+ "404":
+ content:
+ application/json:
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials.
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: One or more optimization settings were unavailable.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -21822,8 +19400,12 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ "409":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Duplicate optimization exists with same parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -21859,9 +19441,8 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -21879,16 +19460,8 @@ paths:
available after successful authentication.
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -21906,87 +19479,28 @@ paths:
available after successful authentication.
type: string
style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
- description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
type: string
style: simple
- summary: Get all calculations
- tags:
- - PACalculations
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: CalculationsSummaryRoot
- x-accepts: application/json
- post:
- description: "This endpoint runs the PA calculation specified in the POST body\
- \ parameters.\r\nIt can take one or more calculation units as input.\r\n\r\
- \nRemarks:\r\n\r\n*\tAny settings in POST body will act as a one-time override\
- \ over the settings saved in the PA template.\r\n\r\n* If we are overriding\
- \ the grouping with a frequency, we will be overriding the grouping saved\
- \ to the original component and also overriding \r\n the default frequency\
- \ of the Beginning of Period to whatever we pass in the request body.\r\n\
- \ \r\n* If we are overriding gouping frequency without overriding the\
- \ group id it will not be applied to the default groupings saved to the original\
- \ component."
- operationId: postAndCalculate
- parameters:
- - description: Long running deadline in seconds when only one unit is passed
- in the POST body.
- explode: false
- in: header
- name: X-FactSet-Api-Long-Running-Deadline
- required: false
- schema:
- type: integer
- style: simple
- - description: Standard HTTP header. Accepts max-stale.
- explode: false
- in: header
- name: Cache-Control
- required: false
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PACalculationParametersRoot'
- description: Calculation Parameters
- responses:
- "202":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response, contains the poll URL in the Location header.
- headers:
- Location:
- description: URL to poll for the resulting calculation
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
- description: URL to poll for the resulting calculation
type: string
style: simple
+ "415":
+ description: Missing/Invalid Content-Type header. Header needs to be set
+ to application/json.
+ headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -22021,17 +19535,9 @@ paths:
schema:
type: string
style: simple
- "201":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response if the calculation has one unit and is completed
- in a short span, returns JSON in the format specified in the Calculation
- parameters.
+ "429":
+ description: Rate limit reached. Cancel older requests using Cancel optimization
+ endpoint or wait for older requests to finish/expire.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22067,16 +19573,16 @@ paths:
schema:
type: string
style: simple
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- application/x-protobuf:
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
+ explode: false
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response, if the calculation has one unit and is completed
- with an error.
+ type: string
+ style: simple
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22094,33 +19600,63 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
- "400":
+ summary: Create or Update NPO optimization and run it.
+ tags:
+ - NPO Optimizer
+ x-are-multiple-success-responses-different: true
+ x-success-response-types:
+ - status-code: "202"
+ response-type: CalculationInfoRoot
+ - status-code: "201"
+ response-type: ObjectRoot
+ x-contentType: application/json
+ x-accepts: application/json
+ /analytics/engines/npo/v3/optimizations/{id}/status:
+ get:
+ description: "This is the endpoint to check on the progress of a previously\
+ \ requested optimization.\r\nIf the optimization has finished computing, the\
+ \ body of the response will contain result in JSON.\r\nOtherwise, the optimization\
+ \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\
+ \ a progress percentage."
+ operationId: getOptimizationStatusById
+ parameters:
+ - description: from url, provided from the location header in the Create and
+ Run NPO optimization endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Create and
+ Run NPO optimization endpoint
+ type: string
+ style: simple
+ responses:
+ "201":
content:
application/json:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid calculation parameters.
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response once optimization is completed, returns JSON.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22156,16 +19692,26 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
+ "202":
+ description: Expected response returned if the optimization is not yet completed,
+ should contain X-FactSet-Api-PickUp-Progress header.
+ headers:
+ X-FactSet-Api-PickUp-Progress:
+ description: FactSet's progress header.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
+ description: FactSet's progress header.
+ type: string
+ style: simple
+ Cache-Control:
+ description: Standard HTTP header. Header will specify max-age in seconds.
+ Polling can be adjusted based on the max-age value.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: One or more calculation settings were unavailable.
- headers:
+ description: Standard HTTP header. Header will specify max-age in
+ seconds. Polling can be adjusted based on the max-age value.
+ type: integer
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -22200,8 +19746,12 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22219,8 +19769,31 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Optimization result was already returned, provided id was not
+ a requested optimization, or the optimization was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22256,9 +19829,8 @@ paths:
schema:
type: string
style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22276,27 +19848,8 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "429":
- description: Rate limit reached. Cancel older requests using Cancel Calculation
- endpoint or wait for older requests to finish/expire.
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22332,16 +19885,9 @@ paths:
schema:
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
- schema:
- type: string
- style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22378,39 +19924,65 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create and Run PA calculation
+ summary: Get NPO optimization status by id
tags:
- - PACalculations
+ - NPO Optimizer
x-are-multiple-success-responses-different: true
x-success-response-types:
- - status-code: "202"
- response-type: CalculationStatusRoot
- status-code: "201"
response-type: ObjectRoot
- - status-code: "200"
- response-type: CalculationStatusRoot
- x-contentType: application/json
+ - status-code: "202"
x-accepts: application/json
- /analytics/engines/pa/v3/calculations/{id}:
- delete:
- description: This is the endpoint to cancel a previously submitted calculation.
- operationId: cancelCalculationById
+ /analytics/engines/npo/v3/optimizations/{id}/result:
+ get:
+ description: This is the endpoint to get the result of a previously requested
+ optimization.
+ operationId: getOptimizationResult
parameters:
- - description: from url, provided from the location header in the Create and
- Run PA calculation endpoint
+ - description: from url, provided from the location header in the Get NPO optimization
+ status by id endpoint
explode: false
in: path
name: id
required: true
schema:
- description: from url, provided from the location header in the Create and
- Run PA calculation endpoint
+ description: from url, provided from the location header in the Get NPO
+ optimization status by id endpoint
type: string
style: simple
responses:
- "204":
- description: Expected response, calculation was canceled successfully.
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response once optimization is completed, returns JSON.
headers:
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ type: string
+ style: simple
+ Content-Type:
+ description: Standard HTTP header.
+ explode: false
+ schema:
+ description: Standard HTTP header.
+ type: string
+ style: simple
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -22447,15 +20019,9 @@ paths:
style: simple
"400":
content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
@@ -22494,17 +20060,11 @@ paths:
style: simple
"404":
content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: There was no request for the calculation identifier provided,
- or the request was already canceled for the provided identifier.
+ description: Optimization result was already returned, provided id was not
+ a requested optimization, or the optimization was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22598,7 +20158,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22635,62 +20195,36 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Cancel PA calculation by id
+ summary: Get NPO optimization result by id
tags:
- - PACalculations
+ - NPO Optimizer
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "204"
+ - status-code: "200"
+ response-type: ObjectRoot
x-accepts: application/json
+ /analytics/engines/pa/v3/calculations:
get:
- description: This is the endpoint that returns the calculation parameters passed
- for a calculation.
- operationId: getCalculationParameters
+ description: This endpoints returns all calculation requests.
+ operationId: getAllCalculations
parameters:
- - description: from url, provided from the location header in the Create and
- Run PA calculation endpoint
- explode: false
- in: path
- name: id
+ - explode: true
+ in: query
+ name: pageNumber
required: true
schema:
- description: from url, provided from the location header in the Create and
- Run PA calculation endpoint
- type: string
- style: simple
+ default: 1
+ format: int32
+ type: integer
+ style: form
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/PACalculationParametersRoot'
- description: Expected response, returns the PA calculation parameters.
+ $ref: '#/components/schemas/CalculationsSummaryRoot'
+ description: List of calculation requests.
headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
- explode: false
- schema:
- description: Standard HTTP header.
- type: string
- style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- explode: false
- schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -22730,7 +20264,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ description: Invalid page number.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22771,7 +20305,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation id not found
+ description: No calculation found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22827,7 +20361,7 @@ paths:
type: string
style: simple
"403":
- description: User is forbidden with current credentials
+ description: User is forbidden with current credentials.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22863,9 +20397,73 @@ paths:
schema:
type: string
style: simple
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
+ explode: false
+ schema:
+ type: string
+ style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -22902,19 +20500,18 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get PA calculation parameters by id
+ summary: Get all calculations
tags:
- PACalculations
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: PACalculationParametersRoot
+ response-type: CalculationsSummaryRoot
x-accepts: application/json
- put:
- description: "This endpoint updates and run the PA calculation specified in\
- \ the PUT body parameters. This also allows creating new PA calculations with\
- \ custom ids.\r\nIt can take one or more calculation units as input.\r\n\r\
- \nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override\
+ post:
+ description: "This endpoint runs the PA calculation specified in the POST body\
+ \ parameters.\r\nIt can take one or more calculation units as input.\r\n\r\
+ \nRemarks:\r\n\r\n*\tAny settings in POST body will act as a one-time override\
\ over the settings saved in the PA template.\r\n\r\n* If we are overriding\
\ the grouping with a frequency, we will be overriding the grouping saved\
\ to the original component and also overriding \r\n the default frequency\
@@ -22922,21 +20519,10 @@ paths:
\ \r\n* If we are overriding gouping frequency without overriding the\
\ group id it will not be applied to the default groupings saved to the original\
\ component."
- operationId: putAndCalculate
+ operationId: postAndCalculate
parameters:
- - description: from url, provided from the location header in the Create and
- Run PA calculation endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Create and
- Run PA calculation endpoint
- type: string
- style: simple
- description: Long running deadline in seconds when only one unit is passed
- in the PUT body.
+ in the POST body.
explode: false
in: header
name: X-FactSet-Api-Long-Running-Deadline
@@ -23010,16 +20596,17 @@ paths:
schema:
type: string
style: simple
- "200":
+ "201":
content:
application/json:
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
+ $ref: '#/components/schemas/ObjectRoot'
application/x-protobuf:
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response, if the calculation has one unit and is completed
- with an error.
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response if the calculation has one unit and is completed
+ in a short span, returns JSON in the format specified in the Calculation
+ parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23055,17 +20642,16 @@ paths:
schema:
type: string
style: simple
- "201":
+ "200":
content:
application/json:
schema:
- $ref: '#/components/schemas/ObjectRoot'
+ $ref: '#/components/schemas/CalculationStatusRoot'
application/x-protobuf:
schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response if the calculation has one unit and is completed
- in a short span, returns JSON in the format specified in the Calculation
- parameters.
+ $ref: '#/components/schemas/CalculationStatusRoot'
+ description: Expected response, if the calculation has one unit and is completed
+ with an error.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23109,7 +20695,7 @@ paths:
application/x-protobuf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid Calculation Parameters.
+ description: Invalid calculation parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23189,15 +20775,27 @@ paths:
schema:
type: string
style: simple
- "409":
- content:
- application/json:
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Duplicate calculation exists with same parameters.
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23233,8 +20831,9 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "415":
+ description: Missing/Invalid Content-Type header. Header needs to be set
+ to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23252,8 +20851,27 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "429":
+ description: Rate limit reached. Cancel older requests using Cancel Calculation
+ endpoint or wait for older requests to finish/expire.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23289,9 +20907,84 @@ paths:
schema:
type: string
style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ summary: Create and Run PA calculation
+ tags:
+ - PACalculations
+ x-are-multiple-success-responses-different: true
+ x-success-response-types:
+ - status-code: "202"
+ response-type: CalculationStatusRoot
+ - status-code: "201"
+ response-type: ObjectRoot
+ - status-code: "200"
+ response-type: CalculationStatusRoot
+ x-contentType: application/json
+ x-accepts: application/json
+ /analytics/engines/pa/v3/calculations/{id}:
+ delete:
+ description: This is the endpoint to cancel a previously submitted calculation.
+ operationId: cancelCalculationById
+ parameters:
+ - description: from url, provided from the location header in the Create and
+ Run PA calculation endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Create and
+ Run PA calculation endpoint
+ type: string
+ style: simple
+ responses:
+ "204":
+ description: Expected response, calculation was canceled successfully.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23327,9 +21020,18 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Cancel older requests using Cancel Calculation
- endpoint or wait for older requests to finish/expire.
+ "400":
+ content:
+ text/plain:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ text/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23365,9 +21067,106 @@ paths:
schema:
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
+ "404":
+ content:
+ text/plain:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ text/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: There was no request for the calculation identifier provided,
+ or the request was already canceled for the provided identifier.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
type: string
@@ -23411,27 +21210,17 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create or Update PA calculation and run it.
+ summary: Cancel PA calculation by id
tags:
- PACalculations
- x-are-multiple-success-responses-different: true
+ x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "202"
- response-type: CalculationStatusRoot
- - status-code: "200"
- response-type: CalculationStatusRoot
- - status-code: "201"
- response-type: ObjectRoot
- x-contentType: application/json
+ - status-code: "204"
x-accepts: application/json
- /analytics/engines/pa/v3/calculations/{id}/status:
get:
- description: "This is the endpoint to check on the progress of a previously\
- \ requested calculation.\r\nIf the calculation has finished computing, the\
- \ location header will point to the result url.\r\nOtherwise, the calculation\
- \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\
- \ a progress percentage."
- operationId: getCalculationStatusById
+ description: This is the endpoint that returns the calculation parameters passed
+ for a calculation.
+ operationId: getCalculationParameters
parameters:
- description: from url, provided from the location header in the Create and
Run PA calculation endpoint
@@ -23449,8 +21238,8 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response once calculation is completed.
+ $ref: '#/components/schemas/PACalculationParametersRoot'
+ description: Expected response, returns the PA calculation parameters.
headers:
Content-Encoding:
description: Standard HTTP header. Header value based on Accept-Encoding
@@ -23511,30 +21300,13 @@ paths:
schema:
type: string
style: simple
- "202":
+ "400":
content:
application/json:
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response returned if the calculation is not yet completed,
- should contain X-FactSet-Api-PickUp-Progress header.
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
headers:
- X-FactSet-Api-PickUp-Progress:
- description: FactSet's progress header.
- explode: false
- schema:
- description: FactSet's progress header.
- type: string
- style: simple
- Cache-Control:
- description: Standard HTTP header. Header will specify max-age in seconds.
- Polling can be adjusted based on the max-age value.
- explode: false
- schema:
- description: Standard HTTP header. Header will specify max-age in
- seconds. Polling can be adjusted based on the max-age value.
- type: integer
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -23569,12 +21341,12 @@ paths:
schema:
type: string
style: simple
- "400":
+ "404":
content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ description: Calculation id not found
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23610,13 +21382,27 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation was already returned, provided id was not a requested
- calculation, or the calculation was cancelled
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23652,9 +21438,119 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ summary: Get PA calculation parameters by id
+ tags:
+ - PACalculations
+ x-are-multiple-success-responses-different: false
+ x-success-response-types:
+ - status-code: "200"
+ response-type: PACalculationParametersRoot
+ x-accepts: application/json
+ put:
+ description: "This endpoint updates and run the PA calculation specified in\
+ \ the PUT body parameters. This also allows creating new PA calculations with\
+ \ custom ids.\r\nIt can take one or more calculation units as input.\r\n\r\
+ \nRemarks:\r\n\r\n*\tAny settings in PUT body will act as a one-time override\
+ \ over the settings saved in the PA template.\r\n\r\n* If we are overriding\
+ \ the grouping with a frequency, we will be overriding the grouping saved\
+ \ to the original component and also overriding \r\n the default frequency\
+ \ of the Beginning of Period to whatever we pass in the request body.\r\n\
+ \ \r\n* If we are overriding gouping frequency without overriding the\
+ \ group id it will not be applied to the default groupings saved to the original\
+ \ component."
+ operationId: putAndCalculate
+ parameters:
+ - description: from url, provided from the location header in the Create and
+ Run PA calculation endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Create and
+ Run PA calculation endpoint
+ type: string
+ style: simple
+ - description: Long running deadline in seconds when only one unit is passed
+ in the PUT body.
+ explode: false
+ in: header
+ name: X-FactSet-Api-Long-Running-Deadline
+ required: false
+ schema:
+ type: integer
+ style: simple
+ - description: Standard HTTP header. Accepts max-stale.
+ explode: false
+ in: header
+ name: Cache-Control
+ required: false
+ schema:
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PACalculationParametersRoot'
+ description: Calculation Parameters
+ responses:
+ "202":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CalculationStatusRoot'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/CalculationStatusRoot'
+ description: Expected response, contains the poll URL in the Location header.
headers:
+ Location:
+ description: URL to poll for the resulting calculation
+ explode: false
+ schema:
+ description: URL to poll for the resulting calculation
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -23667,12 +21563,38 @@ paths:
available after successful authentication.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CalculationStatusRoot'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/CalculationStatusRoot'
+ description: Expected response, if the calculation has one unit and is completed
+ with an error.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23708,28 +21630,17 @@ paths:
schema:
type: string
style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
+ "201":
+ content:
+ application/json:
schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
+ $ref: '#/components/schemas/ObjectRoot'
+ application/x-protobuf:
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response if the calculation has one unit and is completed
+ in a short span, returns JSON in the format specified in the Calculation
+ parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23747,82 +21658,34 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get PA calculation status by id
- tags:
- - PACalculations
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: CalculationStatusRoot
- - status-code: "202"
- response-type: CalculationStatusRoot
- x-accepts: application/json
- /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result:
- get:
- description: "This is the endpoint to get the result of a previously requested\
- \ calculation.\r\nIf the calculation has finished computing, the body of the\
- \ response will contain the requested document in JSON."
- operationId: getCalculationUnitResultById
- parameters:
- - description: from url, provided from the location header in the Get PA calculation
- status by id endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Get PA calculation
- status by id endpoint
- type: string
- style: simple
- - description: from url, provided from the location header in the Get PA calculation
- status by id endpoint
- explode: false
- in: path
- name: unitId
- required: true
- schema:
- description: from url, provided from the location header in the Get PA calculation
- status by id endpoint
- type: string
- style: simple
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response once calculation is completed, returns JSON
- in the format specified in the Calculation parameters.
- headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
type: string
style: simple
- Content-Type:
- description: Standard HTTP header.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: Standard HTTP header.
type: string
style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
type: string
style: simple
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid Calculation Parameters.
+ headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -23857,7 +21720,7 @@ paths:
schema:
type: string
style: simple
- "400":
+ "404":
content:
application/json:
schema:
@@ -23865,7 +21728,7 @@ paths:
application/x-protobuf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ description: One or more calculation settings were unavailable.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -23901,7 +21764,7 @@ paths:
schema:
type: string
style: simple
- "404":
+ "409":
content:
application/json:
schema:
@@ -23909,8 +21772,7 @@ paths:
application/x-protobuf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation was already returned, provided id was not a requested
- calculation, or the calculation was cancelled
+ description: Duplicate calculation exists with same parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24002,9 +21864,9 @@ paths:
schema:
type: string
style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ "415":
+ description: Missing/Invalid Content-Type header. Header needs to be set
+ to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24022,76 +21884,27 @@ paths:
available after successful authentication.
type: string
style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
- description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
type: string
style: simple
- summary: Get PA calculation result by id
- tags:
- - PACalculations
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: ObjectRoot
- x-accepts: application/json
- /analytics/engines/pa/v3/pricing-sources:
- get:
- description: This endpoint lists all the PA pricing sources that can be applied
- to a PA calculation.
- operationId: getPAPricingSources
- parameters:
- - description: PA pricing sources name
- explode: true
- in: query
- name: name
- required: false
- schema:
- default: ""
- description: PA pricing sources name
- type: string
- style: form
- - description: PA pricing sources category
- explode: true
- in: query
- name: category
- required: false
- schema:
- default: ""
- description: PA pricing sources category
- type: string
- style: form
- - description: The directory to get the PA pricing sources in
- explode: true
- in: query
- name: directory
- required: false
- schema:
- default: ""
- description: The directory to get the PA pricing sources in
- type: string
- style: form
- responses:
- "200":
- content:
- application/json:
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
schema:
- $ref: '#/components/schemas/PAPricingSourceRoot'
- description: Expected response, returns a list of PA pricing sources
+ type: string
+ style: simple
+ "429":
+ description: Rate limit reached. Cancel older requests using Cancel Calculation
+ endpoint or wait for older requests to finish/expire.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24109,15 +21922,6 @@ paths:
available after successful authentication.
type: string
style: simple
- Age:
- description: Standard HTTP header. Header will specify the age of pricing
- sources list cached response.
- explode: false
- schema:
- description: Standard HTTP header. Header will specify the age of
- pricing sources list cached response.
- type: integer
- style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -24136,13 +21940,16 @@ paths:
schema:
type: string
style: simple
- "400":
- content:
- application/json:
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid data provided. Please check the request parameters
- before attempting again.
+ type: string
+ style: simple
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24160,31 +21967,91 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ summary: Create or Update PA calculation and run it.
+ tags:
+ - PACalculations
+ x-are-multiple-success-responses-different: true
+ x-success-response-types:
+ - status-code: "202"
+ response-type: CalculationStatusRoot
+ - status-code: "200"
+ response-type: CalculationStatusRoot
+ - status-code: "201"
+ response-type: ObjectRoot
+ x-contentType: application/json
+ x-accepts: application/json
+ /analytics/engines/pa/v3/calculations/{id}/status:
+ get:
+ description: "This is the endpoint to check on the progress of a previously\
+ \ requested calculation.\r\nIf the calculation has finished computing, the\
+ \ location header will point to the result url.\r\nOtherwise, the calculation\
+ \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\
+ \ a progress percentage."
+ operationId: getCalculationStatusById
+ parameters:
+ - description: from url, provided from the location header in the Create and
+ Run PA calculation endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Create and
+ Run PA calculation endpoint
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CalculationStatusRoot'
+ description: Expected response once calculation is completed.
+ headers:
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
explode: false
schema:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
type: string
style: simple
- "404":
- content:
- application/json:
+ Content-Type:
+ description: Standard HTTP header.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Pricing sources not found.
- headers:
+ description: Standard HTTP header.
+ type: string
+ style: simple
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -24219,28 +22086,30 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "202":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CalculationStatusRoot'
+ description: Expected response returned if the calculation is not yet completed,
+ should contain X-FactSet-Api-PickUp-Progress header.
headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-PickUp-Progress:
+ description: FactSet's progress header.
explode: false
schema:
- description: FactSet's request key header.
+ description: FactSet's progress header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ Cache-Control:
+ description: Standard HTTP header. Header will specify max-age in seconds.
+ Polling can be adjusted based on the max-age value.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
+ description: Standard HTTP header. Header will specify max-age in
+ seconds. Polling can be adjusted based on the max-age value.
+ type: integer
style: simple
- "403":
- description: User is forbidden with current credentials
- headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -24275,8 +22144,12 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24312,9 +22185,13 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Calculation was already returned, provided id was not a requested
+ calculation, or the calculation was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24332,35 +22209,26 @@ paths:
available after successful authentication.
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
type: string
style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
type: string
style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24378,35 +22246,8 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get PA pricing sources
- tags:
- - PricingSources
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: PAPricingSourceRoot
- x-accepts: application/json
- /analytics/engines/pub/v3/calculations:
- get:
- description: This endpoints returns all calculation requests.
- operationId: getAllCalculations
- parameters:
- - explode: true
- in: query
- name: pageNumber
- required: true
- schema:
- default: 1
- format: int32
- type: integer
- style: form
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationsSummaryRoot'
- description: List of calculation requests.
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24442,12 +22283,9 @@ paths:
schema:
type: string
style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid page number.
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24465,30 +22303,8 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: No calculation found.
+ "503":
+ description: Request timed out. Retry the request in sometime.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24506,46 +22322,82 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
+ summary: Get PA calculation status by id
+ tags:
+ - PACalculations
+ x-are-multiple-success-responses-different: false
+ x-success-response-types:
+ - status-code: "200"
+ response-type: CalculationStatusRoot
+ - status-code: "202"
+ response-type: CalculationStatusRoot
+ x-accepts: application/json
+ /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result:
+ get:
+ description: "This is the endpoint to get the result of a previously requested\
+ \ calculation.\r\nIf the calculation has finished computing, the body of the\
+ \ response will contain the requested document in JSON."
+ operationId: getCalculationUnitResultById
+ parameters:
+ - description: from url, provided from the location header in the Get PA calculation
+ status by id endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Get PA calculation
+ status by id endpoint
+ type: string
+ style: simple
+ - description: from url, provided from the location header in the Get PA calculation
+ status by id endpoint
+ explode: false
+ in: path
+ name: unitId
+ required: true
+ schema:
+ description: from url, provided from the location header in the Get PA calculation
+ status by id endpoint
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/json:
schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
+ $ref: '#/components/schemas/ObjectRoot'
+ application/x-protobuf:
schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response once calculation is completed, returns JSON
+ in the format specified in the Calculation parameters.
+ headers:
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
explode: false
schema:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ Content-Type:
+ description: Standard HTTP header.
explode: false
schema:
- description: FactSet's request key header.
+ description: Standard HTTP header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials.
- headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -24580,8 +22432,15 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24617,9 +22476,16 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Calculation was already returned, provided id was not a requested
+ calculation, or the calculation was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24637,35 +22503,26 @@ paths:
available after successful authentication.
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
type: string
style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
type: string
style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24683,60 +22540,9 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get all calculations
- tags:
- - PubCalculations
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: CalculationsSummaryRoot
- x-accepts: application/json
- post:
- description: "This endpoint runs the Pub calculation specified in the POST body\
- \ parameters.\r\nIt can take one or more units as input."
- operationId: postAndCalculate
- parameters:
- - description: Long running deadline in seconds when only one unit is passed
- in the POST body.
- explode: false
- in: header
- name: X-FactSet-Api-Long-Running-Deadline
- required: false
- schema:
- type: integer
- style: simple
- - description: Standard HTTP header. Accepts max-stale.
- explode: false
- in: header
- name: Cache-Control
- required: false
- schema:
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PubCalculationParametersRoot'
- description: Calculation Parameters
- responses:
- "202":
- content:
- application/pdf:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- application/vnd.openxmlformats-officedocument.presentationml.presentation:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response, contains the poll URL in the Location header.
+ "403":
+ description: User is forbidden with current credentials
headers:
- Location:
- description: URL to poll for the resulting calculation
- explode: false
- schema:
- description: URL to poll for the resulting calculation
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -24771,16 +22577,9 @@ paths:
schema:
type: string
style: simple
- "200":
- content:
- application/pdf:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- application/vnd.openxmlformats-officedocument.presentationml.presentation:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response, if the calculation has one unit and is completed
- with an error.
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24798,37 +22597,76 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
- "201":
+ summary: Get PA calculation result by id
+ tags:
+ - PACalculations
+ x-are-multiple-success-responses-different: false
+ x-success-response-types:
+ - status-code: "200"
+ response-type: ObjectRoot
+ x-accepts: application/json
+ /analytics/engines/pa/v3/pricing-sources:
+ get:
+ description: This endpoint lists all the PA pricing sources that can be applied
+ to a PA calculation.
+ operationId: getPAPricingSources
+ parameters:
+ - description: PA pricing sources name
+ explode: true
+ in: query
+ name: name
+ required: false
+ schema:
+ default: ""
+ description: PA pricing sources name
+ type: string
+ style: form
+ - description: PA pricing sources category
+ explode: true
+ in: query
+ name: category
+ required: false
+ schema:
+ default: ""
+ description: PA pricing sources category
+ type: string
+ style: form
+ - description: The directory to get the PA pricing sources in
+ explode: true
+ in: query
+ name: directory
+ required: false
+ schema:
+ default: ""
+ description: The directory to get the PA pricing sources in
+ type: string
+ style: form
+ responses:
+ "200":
content:
- application/pdf:
- schema:
- format: binary
- type: string
- application/vnd.openxmlformats-officedocument.presentationml.presentation:
+ application/json:
schema:
- format: binary
- type: string
- description: Expected response if the calculation has one unit and is completed
- in a short span, returns JSON in the format specified in the Calculation
- parameters.
+ $ref: '#/components/schemas/PAPricingSourceRoot'
+ description: Expected response, returns a list of PA pricing sources
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24846,6 +22684,15 @@ paths:
available after successful authentication.
type: string
style: simple
+ Age:
+ description: Standard HTTP header. Header will specify the age of pricing
+ sources list cached response.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header will specify the age of
+ pricing sources list cached response.
+ type: integer
+ style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -24866,13 +22713,11 @@ paths:
style: simple
"400":
content:
- application/pdf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/vnd.openxmlformats-officedocument.presentationml.presentation:
+ application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid calculation parameters.
+ description: Invalid data provided. Please check the request parameters
+ before attempting again.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -24910,13 +22755,10 @@ paths:
style: simple
"404":
content:
- application/pdf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/vnd.openxmlformats-officedocument.presentationml.presentation:
+ application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: One or more calculation settings were unavailable.
+ description: Pricing sources not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -25008,9 +22850,8 @@ paths:
schema:
type: string
style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -25047,8 +22888,8 @@ paths:
type: string
style: simple
"429":
- description: Rate limit reached. Cancel older requests using Cancel Calculation
- endpoint or wait for older requests to finish/expire.
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -25066,24 +22907,6 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
Retry-After:
description: Time to wait in seconds before making a new request as
the rate limit has reached.
@@ -25093,7 +22916,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -25130,38 +22953,35 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create and Run Pub calculation
+ summary: Get PA pricing sources
tags:
- - PubCalculations
- x-are-multiple-success-responses-different: true
+ - PricingSources
+ x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "202"
- response-type: CalculationStatusRoot
- status-code: "200"
- response-type: CalculationStatusRoot
- - status-code: "201"
- is-file: true
- x-contentType: application/json
- x-accepts: application/pdf,application/vnd.openxmlformats-officedocument.presentationml.presentation
- /analytics/engines/pub/v3/calculations/{id}:
- delete:
- description: This is the endpoint to cancel a previously submitted calculation.
- operationId: cancelCalculationById
+ response-type: PAPricingSourceRoot
+ x-accepts: application/json
+ /analytics/engines/pub/v3/calculations:
+ get:
+ description: This endpoints returns all calculation requests.
+ operationId: getAllCalculations
parameters:
- - description: from url, provided from the location header in the Create and
- Run Pub calculation endpoint
- explode: false
- in: path
- name: id
+ - explode: true
+ in: query
+ name: pageNumber
required: true
schema:
- description: from url, provided from the location header in the Create and
- Run Pub calculation endpoint
- type: string
- style: simple
+ default: 1
+ format: int32
+ type: integer
+ style: form
responses:
- "204":
- description: Expected response, calculation was canceled successfully.
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CalculationsSummaryRoot'
+ description: List of calculation requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -25199,16 +23019,10 @@ paths:
style: simple
"400":
content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ description: Invalid page number.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -25246,17 +23060,10 @@ paths:
style: simple
"404":
content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: There was no request for the calculation identifier provided,
- or the request was already canceled for the provided identifier.
+ description: No calculation found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -25311,178 +23118,8 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- summary: Cancel Pub calculation by id
- tags:
- - PubCalculations
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "204"
- x-accepts: application/json
- get:
- description: This is the endpoint that returns the calculation parameters passed
- for a calculation.
- operationId: getCalculationParameters
- parameters:
- - description: from url, provided from the location header in the Create and
- Run Pub calculation endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Create and
- Run Pub calculation endpoint
- type: string
- style: simple
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PubCalculationParametersRoot'
- description: Expected response, returns the Pub calculation parameters.
- headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
- explode: false
- schema:
- description: Standard HTTP header.
- type: string
- style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- explode: false
- schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- type: string
- style: simple
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ "403":
+ description: User is forbidden with current credentials.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -25518,12 +23155,8 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation id not found
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -25559,27 +23192,9 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -25597,27 +23212,16 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
explode: false
schema:
type: string
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -25654,35 +23258,21 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Pub calculation parameters by id
+ summary: Get all calculations
tags:
- PubCalculations
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: PubCalculationParametersRoot
+ response-type: CalculationsSummaryRoot
x-accepts: application/json
- put:
- description: "This endpoint updates and run the Pub calculation specified in\
- \ the PUT body parameters. This also allows creating new Pub calculations\
- \ with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\
- \n\r\n* Start and and end date must be within the configuration's min and\
- \ max date range"
- operationId: putAndCalculate
+ post:
+ description: "This endpoint runs the Pub calculation specified in the POST body\
+ \ parameters.\r\nIt can take one or more units as input."
+ operationId: postAndCalculate
parameters:
- - description: from url, provided from the location header in the Create and
- Run Pub calculation endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Create and
- Run Pub calculation endpoint
- type: string
- style: simple
- description: Long running deadline in seconds when only one unit is passed
- in the PUT body.
+ in the POST body.
explode: false
in: header
name: X-FactSet-Api-Long-Running-Deadline
@@ -25710,6 +23300,9 @@ paths:
application/pdf:
schema:
$ref: '#/components/schemas/CalculationStatusRoot'
+ application/vnd.openxmlformats-officedocument.presentationml.presentation:
+ schema:
+ $ref: '#/components/schemas/CalculationStatusRoot'
description: Expected response, contains the poll URL in the Location header.
headers:
Location:
@@ -25735,20 +23328,6 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -25772,6 +23351,9 @@ paths:
application/pdf:
schema:
$ref: '#/components/schemas/CalculationStatusRoot'
+ application/vnd.openxmlformats-officedocument.presentationml.presentation:
+ schema:
+ $ref: '#/components/schemas/CalculationStatusRoot'
description: Expected response, if the calculation has one unit and is completed
with an error.
headers:
@@ -25791,20 +23373,6 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -25829,6 +23397,10 @@ paths:
schema:
format: binary
type: string
+ application/vnd.openxmlformats-officedocument.presentationml.presentation:
+ schema:
+ format: binary
+ type: string
description: Expected response if the calculation has one unit and is completed
in a short span, returns JSON in the format specified in the Calculation
parameters.
@@ -25849,20 +23421,6 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -25886,7 +23444,10 @@ paths:
application/pdf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid Calculation Parameters.
+ application/vnd.openxmlformats-officedocument.presentationml.presentation:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid calculation parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -25904,20 +23465,6 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -25941,6 +23488,9 @@ paths:
application/pdf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
+ application/vnd.openxmlformats-officedocument.presentationml.presentation:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
description: One or more calculation settings were unavailable.
headers:
X-DataDirect-Request-Key:
@@ -25959,20 +23509,6 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -25991,12 +23527,8 @@ paths:
schema:
type: string
style: simple
- "409":
- content:
- application/pdf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Duplicate calculation exists with same parameters.
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26014,18 +23546,23 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
+ "403":
+ description: User is forbidden with current credentials
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
- description: Maximum FI request limit.
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
- description: Number of FI requests remaining till request limit reached.
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
X-FactSet-Api-RateLimit-Limit:
@@ -26046,8 +23583,9 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "415":
+ description: Missing/Invalid Content-Type header. Header needs to be set
+ to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26065,22 +23603,27 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
- description: Maximum FI request limit.
type: string
style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: Number of FI requests remaining till request limit reached.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "429":
+ description: Rate limit reached. Cancel older requests using Cancel Calculation
+ endpoint or wait for older requests to finish/expire.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26098,41 +23641,53 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
- description: Maximum FI request limit.
type: string
style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: Number of FI requests remaining till request limit reached.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
type: string
style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
explode: false
schema:
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
+ description: FactSet's request key header.
type: string
style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "503":
+ description: Request timed out. Retry the request in sometime.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26150,18 +23705,53 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
+ summary: Create and Run Pub calculation
+ tags:
+ - PubCalculations
+ x-are-multiple-success-responses-different: true
+ x-success-response-types:
+ - status-code: "202"
+ response-type: CalculationStatusRoot
+ - status-code: "200"
+ response-type: CalculationStatusRoot
+ - status-code: "201"
+ is-file: true
+ x-contentType: application/json
+ x-accepts: application/pdf,application/vnd.openxmlformats-officedocument.presentationml.presentation
+ /analytics/engines/pub/v3/calculations/{id}:
+ delete:
+ description: This is the endpoint to cancel a previously submitted calculation.
+ operationId: cancelCalculationById
+ parameters:
+ - description: from url, provided from the location header in the Create and
+ Run Pub calculation endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Create and
+ Run Pub calculation endpoint
+ type: string
+ style: simple
+ responses:
+ "204":
+ description: Expected response, calculation was canceled successfully.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
- description: Maximum FI request limit.
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
- description: Number of FI requests remaining till request limit reached.
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
X-FactSet-Api-RateLimit-Limit:
@@ -26182,9 +23772,18 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Cancel older requests using Cancel Calculation
- endpoint or wait for older requests to finish/expire.
+ "400":
+ content:
+ text/plain:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ text/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26202,20 +23801,6 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
- explode: false
- schema:
- description: Maximum FI request limit.
- type: string
- style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
- explode: false
- schema:
- description: Number of FI requests remaining till request limit reached.
- type: string
- style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -26234,16 +23819,19 @@ paths:
schema:
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
+ "404":
+ content:
+ text/plain:
schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ text/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: There was no request for the calculation identifier provided,
+ or the request was already canceled for the provided identifier.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26261,22 +23849,26 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
- description: Maximum FI request limit.
type: string
style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: Number of FI requests remaining till request limit reached.
type: string
style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26294,84 +23886,47 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-Calculations-Limit:
- description: Maximum FI request limit.
+ "403":
+ description: User is forbidden with current credentials
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
- description: Maximum FI request limit.
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Calculations-Remaining:
- description: Number of FI requests remaining till request limit reached.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
- description: Number of FI requests remaining till request limit reached.
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
- summary: Create or Update Pub calculation and run it.
- tags:
- - PubCalculations
- x-are-multiple-success-responses-different: true
- x-success-response-types:
- - status-code: "202"
- response-type: CalculationStatusRoot
- - status-code: "200"
- response-type: CalculationStatusRoot
- - status-code: "201"
- is-file: true
- x-contentType: application/json
- x-accepts: application/pdf
- /analytics/engines/pub/v3/calculations/{id}/status:
- get:
- description: "This is the endpoint to check on the progress of a previously\
- \ requested calculation.\r\nIf the calculation has finished computing, the\
- \ location header will point to the result url."
- operationId: getCalculationStatusById
- parameters:
- - description: from url, provided from the location header in the Create and
- Run Pub calculation endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Create and
- Run Pub calculation endpoint
- type: string
- style: simple
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response once calculation is completed.
- headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
type: string
style: simple
- Content-Type:
- description: Standard HTTP header.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: Standard HTTP header.
type: string
style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
type: string
style: simple
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
+ headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -26388,46 +23943,80 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ summary: Cancel Pub calculation by id
+ tags:
+ - PubCalculations
+ x-are-multiple-success-responses-different: false
+ x-success-response-types:
+ - status-code: "204"
+ x-accepts: application/json
+ get:
+ description: This is the endpoint that returns the calculation parameters passed
+ for a calculation.
+ operationId: getCalculationParameters
+ parameters:
+ - description: from url, provided from the location header in the Create and
+ Run Pub calculation endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Create and
+ Run Pub calculation endpoint
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PubCalculationParametersRoot'
+ description: Expected response, returns the Pub calculation parameters.
+ headers:
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
explode: false
schema:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
type: string
style: simple
- "202":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response returned if the calculation is not yet completed.
- headers:
- X-FactSet-Api-PickUp-Progress:
- description: FactSet's progress header.
+ Content-Type:
+ description: Standard HTTP header.
explode: false
schema:
- description: FactSet's progress header.
+ description: Standard HTTP header.
type: string
style: simple
- Cache-Control:
- description: Standard HTTP header. Header will specify max-age in seconds.
- Polling can be adjusted based on the max-age value.
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
explode: false
schema:
- description: Standard HTTP header. Header will specify max-age in
- seconds. Polling can be adjusted based on the max-age value.
- type: integer
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ type: string
style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26509,8 +24098,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation was already returned, provided id was not a requested
- calculation, or the calculation was cancelled
+ description: Calculation id not found
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26641,86 +24229,69 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Pub calculation status by id
+ summary: Get Pub calculation parameters by id
tags:
- PubCalculations
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: CalculationStatusRoot
- - status-code: "202"
- response-type: CalculationStatusRoot
+ response-type: PubCalculationParametersRoot
x-accepts: application/json
- /analytics/engines/pub/v3/calculations/{id}/units/{unitId}/result:
- get:
- description: "This is the endpoint to get the result of a previously requested\
- \ calculation.\r\nIf the calculation has finished computing, the body of the\
- \ response will contain the requested document in the specified format."
- operationId: getCalculationUnitResultById
+ put:
+ description: "This endpoint updates and run the Pub calculation specified in\
+ \ the PUT body parameters. This also allows creating new Pub calculations\
+ \ with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\
+ \n\r\n* Start and and end date must be within the configuration's min and\
+ \ max date range"
+ operationId: putAndCalculate
parameters:
- - description: from url, provided from the location header in the Get Pub calculation
- status by id endpoint
+ - description: from url, provided from the location header in the Create and
+ Run Pub calculation endpoint
explode: false
in: path
name: id
required: true
schema:
- description: from url, provided from the location header in the Get Pub
- calculation status by id endpoint
+ description: from url, provided from the location header in the Create and
+ Run Pub calculation endpoint
type: string
style: simple
- - description: from url, provided from the location header in the Get Pub calculation
- status by id endpoint
+ - description: Long running deadline in seconds when only one unit is passed
+ in the PUT body.
explode: false
- in: path
- name: unitId
- required: true
+ in: header
+ name: X-FactSet-Api-Long-Running-Deadline
+ required: false
+ schema:
+ type: integer
+ style: simple
+ - description: Standard HTTP header. Accepts max-stale.
+ explode: false
+ in: header
+ name: Cache-Control
+ required: false
schema:
- description: from url, provided from the location header in the Get Pub
- calculation status by id endpoint
type: string
style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PubCalculationParametersRoot'
+ description: Calculation Parameters
responses:
- "200":
+ "202":
content:
- application/json:
- schema:
- format: binary
- type: string
- application/x-protobuf:
- schema:
- format: binary
- type: string
application/pdf:
schema:
- format: binary
- type: string
- description: Expected response once calculation is completed, returns result
- in the format specified in the Calculation parameters.
+ $ref: '#/components/schemas/CalculationStatusRoot'
+ description: Expected response, contains the poll URL in the Location header.
headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
- explode: false
- schema:
- description: Standard HTTP header.
- type: string
- style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
+ Location:
+ description: URL to poll for the resulting calculation
explode: false
schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
+ description: URL to poll for the resulting calculation
type: string
style: simple
X-DataDirect-Request-Key:
@@ -26739,6 +24310,20 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
+ explode: false
+ schema:
+ description: Maximum FI request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FI requests remaining till request limit reached.
+ type: string
+ style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -26757,18 +24342,13 @@ paths:
schema:
type: string
style: simple
- "400":
+ "200":
content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
application/pdf:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ $ref: '#/components/schemas/CalculationStatusRoot'
+ description: Expected response, if the calculation has one unit and is completed
+ with an error.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26786,6 +24366,20 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
+ explode: false
+ schema:
+ description: Maximum FI request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FI requests remaining till request limit reached.
+ type: string
+ style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -26804,19 +24398,15 @@ paths:
schema:
type: string
style: simple
- "404":
+ "201":
content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
application/pdf:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation was already returned, provided id was not a requested
- calculation, or the calculation was cancelled
+ format: binary
+ type: string
+ description: Expected response if the calculation has one unit and is completed
+ in a short span, returns JSON in the format specified in the Calculation
+ parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26834,6 +24424,20 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
+ explode: false
+ schema:
+ description: Maximum FI request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FI requests remaining till request limit reached.
+ type: string
+ style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -26852,8 +24456,12 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "400":
+ content:
+ application/pdf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid Calculation Parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26871,23 +24479,18 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
explode: false
schema:
- description: FactSet's request key header.
+ description: Maximum FI request limit.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
X-FactSet-Api-RateLimit-Limit:
@@ -26908,28 +24511,12 @@ paths:
schema:
type: string
style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
+ "404":
+ content:
+ application/pdf:
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: One or more calculation settings were unavailable.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -26947,50 +24534,18 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Pub calculation result by id
- tags:
- - PubCalculations
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- is-file: true
- x-accepts: application/json
- /analytics/engines/quant/v3/calculations:
- get:
- description: This endpoints returns all calculation requests.
- operationId: getAllCalculations
- parameters:
- - explode: true
- in: query
- name: pageNumber
- required: true
- schema:
- default: 1
- format: int32
- type: integer
- style: form
- responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationsSummaryRoot'
- description: List of calculation requests.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
explode: false
schema:
- description: FactSet's request key header.
+ description: Maximum FI request limit.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
X-FactSet-Api-RateLimit-Limit:
@@ -27011,12 +24566,12 @@ paths:
schema:
type: string
style: simple
- "400":
+ "409":
content:
- application/json:
+ application/pdf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid page number.
+ description: Duplicate calculation exists with same parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -27034,6 +24589,20 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
+ explode: false
+ schema:
+ description: Maximum FI request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FI requests remaining till request limit reached.
+ type: string
+ style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -27052,12 +24621,8 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: No calculation found.
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -27075,26 +24640,22 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
explode: false
schema:
+ description: Maximum FI request limit.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
explode: false
schema:
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -27112,23 +24673,18 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
explode: false
schema:
- description: FactSet's request key header.
+ description: Maximum FI request limit.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ description: Number of FI requests remaining till request limit reached.
type: string
style: simple
X-FactSet-Api-RateLimit-Limit:
@@ -27149,8 +24705,9 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ "415":
+ description: Missing/Invalid Content-Type header. Header needs to be set
+ to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -27168,6 +24725,20 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
+ explode: false
+ schema:
+ description: Maximum FI request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FI requests remaining till request limit reached.
+ type: string
+ style: simple
X-FactSet-Api-RateLimit-Limit:
description: Number of allowed requests for the time window.
explode: false
@@ -27187,8 +24758,8 @@ paths:
type: string
style: simple
"429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
+ description: Rate limit reached. Cancel older requests using Cancel Calculation
+ endpoint or wait for older requests to finish/expire.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -27206,6 +24777,38 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
+ explode: false
+ schema:
+ description: Maximum FI request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FI requests remaining till request limit reached.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
Retry-After:
description: Time to wait in seconds before making a new request as
the rate limit has reached.
@@ -27233,6 +24836,20 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
+ explode: false
+ schema:
+ description: Maximum FI request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FI requests remaining till request limit reached.
+ type: string
+ style: simple
"503":
description: Request timed out. Retry the request in sometime.
headers:
@@ -27252,48 +24869,82 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get all calculations
+ X-FactSet-Api-Calculations-Limit:
+ description: Maximum FI request limit.
+ explode: false
+ schema:
+ description: Maximum FI request limit.
+ type: string
+ style: simple
+ X-FactSet-Api-Calculations-Remaining:
+ description: Number of FI requests remaining till request limit reached.
+ explode: false
+ schema:
+ description: Number of FI requests remaining till request limit reached.
+ type: string
+ style: simple
+ summary: Create or Update Pub calculation and run it.
tags:
- - QuantCalculations
- x-are-multiple-success-responses-different: false
+ - PubCalculations
+ x-are-multiple-success-responses-different: true
x-success-response-types:
+ - status-code: "202"
+ response-type: CalculationStatusRoot
- status-code: "200"
- response-type: CalculationsSummaryRoot
- x-accepts: application/json
- post:
- description: "This endpoint runs the Quant Engine calculation specified in the\
- \ POST body parameters.\r\nIt can take one or more calculation units as input."
- operationId: postAndCalculate
+ response-type: CalculationStatusRoot
+ - status-code: "201"
+ is-file: true
+ x-contentType: application/json
+ x-accepts: application/pdf
+ /analytics/engines/pub/v3/calculations/{id}/status:
+ get:
+ description: "This is the endpoint to check on the progress of a previously\
+ \ requested calculation.\r\nIf the calculation has finished computing, the\
+ \ location header will point to the result url."
+ operationId: getCalculationStatusById
parameters:
- - description: Standard HTTP header. Accepts no-store, max-age, max-stale.
+ - description: from url, provided from the location header in the Create and
+ Run Pub calculation endpoint
explode: false
- in: header
- name: Cache-Control
- required: false
+ in: path
+ name: id
+ required: true
schema:
+ description: from url, provided from the location header in the Create and
+ Run Pub calculation endpoint
type: string
style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/QuantCalculationParametersRoot'
responses:
- "202":
+ "200":
content:
application/json:
schema:
$ref: '#/components/schemas/CalculationStatusRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response, contains the poll URL in the Location header.
+ description: Expected response once calculation is completed.
headers:
- Location:
- description: URL to poll for the resulting calculation
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
explode: false
schema:
- description: URL to poll for the resulting calculation
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ type: string
+ style: simple
+ Content-Type:
+ description: Standard HTTP header.
+ explode: false
+ schema:
+ description: Standard HTTP header.
+ type: string
+ style: simple
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
type: string
style: simple
X-DataDirect-Request-Key:
@@ -27330,63 +24981,29 @@ paths:
schema:
type: string
style: simple
- "201":
+ "202":
content:
application/json:
schema:
- $ref: '#/components/schemas/ObjectRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response if the calculation has one unit and is completed
- in a short span, returns JSON in the format specified in the Calculation
- parameters.
+ $ref: '#/components/schemas/CalculationStatusRoot'
+ description: Expected response returned if the calculation is not yet completed.
headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ X-FactSet-Api-PickUp-Progress:
+ description: FactSet's progress header.
explode: false
schema:
+ description: FactSet's progress header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ Cache-Control:
+ description: Standard HTTP header. Header will specify max-age in seconds.
+ Polling can be adjusted based on the max-age value.
explode: false
schema:
- type: string
+ description: Standard HTTP header. Header will specify max-age in
+ seconds. Polling can be adjusted based on the max-age value.
+ type: integer
style: simple
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response if the calculation has one unit and is completed
- with an error.
- headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -27426,10 +25043,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid calculation parameters.
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -27470,10 +25084,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: One or more calculation settings were unavailable.
+ description: Calculation was already returned, provided id was not a requested
+ calculation, or the calculation was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -27565,92 +25177,9 @@ paths:
schema:
type: string
style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "429":
- description: Rate limit reached. Cancel older requests using Cancel Calculation
- endpoint or wait for older requests to finish/expire.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
- schema:
- type: string
- style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -27687,39 +25216,88 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create and Run Quant Engine calculation
+ summary: Get Pub calculation status by id
tags:
- - QuantCalculations
- x-are-multiple-success-responses-different: true
+ - PubCalculations
+ x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "202"
- response-type: CalculationStatusRoot
- - status-code: "201"
- response-type: ObjectRoot
- status-code: "200"
response-type: CalculationStatusRoot
- x-contentType: application/json
+ - status-code: "202"
+ response-type: CalculationStatusRoot
x-accepts: application/json
- /analytics/engines/quant/v3/calculations/{id}:
- delete:
- description: This is the endpoint to cancel a previously submitted calculation.
- operationId: cancelCalculationById
+ /analytics/engines/pub/v3/calculations/{id}/units/{unitId}/result:
+ get:
+ description: "This is the endpoint to get the result of a previously requested\
+ \ calculation.\r\nIf the calculation has finished computing, the body of the\
+ \ response will contain the requested document in the specified format."
+ operationId: getCalculationUnitResultById
parameters:
- - description: from url, provided from the location header in the Create and
- Run Quant calculation endpoint
+ - description: from url, provided from the location header in the Get Pub calculation
+ status by id endpoint
explode: false
in: path
name: id
required: true
schema:
- description: from url, provided from the location header in the Create and
- Run Quant calculation endpoint
+ description: from url, provided from the location header in the Get Pub
+ calculation status by id endpoint
+ type: string
+ style: simple
+ - description: from url, provided from the location header in the Get Pub calculation
+ status by id endpoint
+ explode: false
+ in: path
+ name: unitId
+ required: true
+ schema:
+ description: from url, provided from the location header in the Get Pub
+ calculation status by id endpoint
type: string
style: simple
responses:
- "204":
- description: Expected response, calculation was canceled successfully.
+ "200":
+ content:
+ application/json:
+ schema:
+ format: binary
+ type: string
+ application/x-protobuf:
+ schema:
+ format: binary
+ type: string
+ application/pdf:
+ schema:
+ format: binary
+ type: string
+ description: Expected response once calculation is completed, returns result
+ in the format specified in the Calculation parameters.
headers:
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ type: string
+ style: simple
+ Content-Type:
+ description: Standard HTTP header.
+ explode: false
+ schema:
+ description: Standard HTTP header.
+ type: string
+ style: simple
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -27756,13 +25334,13 @@ paths:
style: simple
"400":
content:
- text/plain:
+ application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/json:
+ application/x-protobuf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- text/json:
+ application/pdf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
description: Invalid identifier provided.
@@ -27803,17 +25381,17 @@ paths:
style: simple
"404":
content:
- text/plain:
+ application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/json:
+ application/x-protobuf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- text/json:
+ application/pdf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: There was no request for the calculation identifier provided,
- or the request was already canceled for the provided identifier.
+ description: Calculation was already returned, provided id was not a requested
+ calculation, or the calculation was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -27907,7 +25485,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -27944,62 +25522,36 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Cancel Quant calculation by id
+ summary: Get Pub calculation result by id
tags:
- - QuantCalculations
+ - PubCalculations
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "204"
+ - status-code: "200"
+ is-file: true
x-accepts: application/json
+ /analytics/engines/quant/v3/calculations:
get:
- description: This is the endpoint that returns the calculation parameters passed
- for a calculation.
- operationId: getCalculationParameters
+ description: This endpoints returns all calculation requests.
+ operationId: getAllCalculations
parameters:
- - description: from url, provided from the location header in the Create and
- Run Quant Engine calculation endpoint
- explode: false
- in: path
- name: id
+ - explode: true
+ in: query
+ name: pageNumber
required: true
schema:
- description: from url, provided from the location header in the Create and
- Run Quant Engine calculation endpoint
- type: string
- style: simple
+ default: 1
+ format: int32
+ type: integer
+ style: form
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/QuantCalculationParametersRoot'
- description: Expected response, returns the Quant Engine calculation parameters.
+ $ref: '#/components/schemas/CalculationsSummaryRoot'
+ description: List of calculation requests.
headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
- explode: false
- schema:
- description: Standard HTTP header.
- type: string
- style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- explode: false
- schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -28039,7 +25591,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ description: Invalid page number.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -28080,7 +25632,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation id not found
+ description: No calculation found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -28136,7 +25688,7 @@ paths:
type: string
style: simple
"403":
- description: User is forbidden with current credentials
+ description: User is forbidden with current credentials.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -28172,9 +25724,73 @@ paths:
schema:
type: string
style: simple
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
+ explode: false
+ schema:
+ type: string
+ style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -28211,31 +25827,19 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Quant Engine calculation parameters by id
+ summary: Get all calculations
tags:
- QuantCalculations
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: QuantCalculationParametersRoot
+ response-type: CalculationsSummaryRoot
x-accepts: application/json
- put:
- description: "This endpoint updates and runs the Quant Engine calculation specified\
- \ in the PUT body parameters. This also allows creating new Quant Engine calculations\
- \ with custom ids.\r\nIt can take one or more calculation units as input."
- operationId: putAndCalculate
+ post:
+ description: "This endpoint runs the Quant Engine calculation specified in the\
+ \ POST body parameters.\r\nIt can take one or more calculation units as input."
+ operationId: postAndCalculate
parameters:
- - description: from url, provided from the location header in the Create and
- Run Quant Engine calculation endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Create and
- Run Quant Engine calculation endpoint
- type: string
- style: simple
- description: Standard HTTP header. Accepts no-store, max-age, max-stale.
explode: false
in: header
@@ -28249,7 +25853,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/QuantCalculationParametersRoot'
- description: Calculation Parameters
responses:
"202":
content:
@@ -28259,6 +25862,9 @@ paths:
application/x-protobuf:
schema:
$ref: '#/components/schemas/CalculationStatusRoot'
+ application/octet-stream:
+ schema:
+ $ref: '#/components/schemas/CalculationStatusRoot'
description: Expected response, contains the poll URL in the Location header.
headers:
Location:
@@ -28302,16 +25908,23 @@ paths:
schema:
type: string
style: simple
- "200":
+ "201":
content:
application/json:
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
+ format: binary
+ type: string
application/x-protobuf:
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
+ format: binary
+ type: string
+ application/octet-stream:
+ schema:
+ format: binary
+ type: string
description: Expected response if the calculation has one unit and is completed
- with an error.
+ in a short span, returns JSON in the format specified in the Calculation
+ parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -28347,17 +25960,16 @@ paths:
schema:
type: string
style: simple
- "201":
+ "200":
content:
application/json:
schema:
- $ref: '#/components/schemas/ObjectRoot'
+ $ref: '#/components/schemas/CalculationStatusRoot'
application/x-protobuf:
schema:
- $ref: '#/components/schemas/ObjectRoot'
+ $ref: '#/components/schemas/CalculationStatusRoot'
description: Expected response if the calculation has one unit and is completed
- in a short span, returns JSON in the format specified in the Calculation
- parameters.
+ with an error.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -28401,7 +26013,7 @@ paths:
application/x-protobuf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid Calculation Parameters.
+ description: Invalid calculation parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -28481,7 +26093,7 @@ paths:
schema:
type: string
style: simple
- "409":
+ "413":
content:
application/json:
schema:
@@ -28489,7 +26101,7 @@ paths:
application/x-protobuf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Duplicate calculation exists with same parameters.
+ description: Request body too large
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -28703,72 +26315,39 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create or update Quant Engine calculation and run it.
+ summary: Create and Run Quant Engine calculation
tags:
- QuantCalculations
x-are-multiple-success-responses-different: true
x-success-response-types:
- status-code: "202"
response-type: CalculationStatusRoot
- - status-code: "200"
- response-type: CalculationStatusRoot
- status-code: "201"
response-type: ObjectRoot
+ - status-code: "200"
+ response-type: CalculationStatusRoot
x-contentType: application/json
x-accepts: application/json
- /analytics/engines/quant/v3/calculations/{id}/status:
- get:
- description: "This is the endpoint to check on the progress of a previously\
- \ requested calculation.\r\nIf the calculation has finished computing, the\
- \ location header will point to the result url.\r\nOtherwise, the calculation\
- \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\
- \ a progress percentage."
- operationId: getCalculationStatusById
+ /analytics/engines/quant/v3/calculations/{id}:
+ delete:
+ description: This is the endpoint to cancel a previously submitted calculation.
+ operationId: cancelCalculationById
parameters:
- description: from url, provided from the location header in the Create and
- Run Quant Engine calculation endpoint
+ Run Quant calculation endpoint
explode: false
in: path
name: id
required: true
schema:
description: from url, provided from the location header in the Create and
- Run Quant Engine calculation endpoint
+ Run Quant calculation endpoint
type: string
style: simple
responses:
- "200":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response once calculation is completed.
+ "204":
+ description: Expected response, calculation was canceled successfully.
headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
- explode: false
- schema:
- description: Standard HTTP header.
- type: string
- style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- explode: false
- schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -28803,30 +26382,19 @@ paths:
schema:
type: string
style: simple
- "202":
+ "400":
content:
- application/json:
+ text/plain:
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response returned if the calculation is not yet completed,
- should contain X-FactSet-Api-PickUp-Progress header.
- headers:
- X-FactSet-Api-PickUp-Progress:
- description: FactSet's progress header.
- explode: false
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/json:
schema:
- description: FactSet's progress header.
- type: string
- style: simple
- Cache-Control:
- description: Standard HTTP header. Header will specify max-age in seconds.
- Polling can be adjusted based on the max-age value.
- explode: false
+ $ref: '#/components/schemas/ClientErrorResponse'
+ text/json:
schema:
- description: Standard HTTP header. Header will specify max-age in
- seconds. Polling can be adjusted based on the max-age value.
- type: integer
- style: simple
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
+ headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -28861,54 +26429,19 @@ paths:
schema:
type: string
style: simple
- "400":
+ "404":
content:
- application/json:
+ text/plain:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "404":
- content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation was already returned, provided id was not a requested
- calculation, or the calculation was cancelled
+ text/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: There was no request for the calculation identifier provided,
+ or the request was already canceled for the provided identifier.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -29002,7 +26535,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -29039,43 +26572,27 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Quant Engine calculation status by id
+ summary: Cancel Quant calculation by id
tags:
- QuantCalculations
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "200"
- response-type: CalculationStatusRoot
- - status-code: "202"
- response-type: CalculationStatusRoot
+ - status-code: "204"
x-accepts: application/json
- /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/result:
get:
- description: "This is the endpoint to get the result of a previously requested\
- \ calculation.\r\nIf the calculation has finished computing, the body of the\
- \ response will contain the requested document in JSON."
- operationId: getCalculationUnitResultById
+ description: This is the endpoint that returns the calculation parameters passed
+ for a calculation.
+ operationId: getCalculationParameters
parameters:
- - description: from url, provided from the location header in the Get Quant
- Engine calculation status by id endpoint
+ - description: from url, provided from the location header in the Create and
+ Run Quant Engine calculation endpoint
explode: false
in: path
name: id
required: true
schema:
- description: from url, provided from the location header in the Get Quant
- Engine calculation status by id endpoint
- type: string
- style: simple
- - description: from url, provided from the location header in the Get Quant
- Engine calculation status by id endpoint
- explode: false
- in: path
- name: unitId
- required: true
- schema:
- description: from url, provided from the location header in the Get Quant
- Engine calculation status by id endpoint
+ description: from url, provided from the location header in the Create and
+ Run Quant Engine calculation endpoint
type: string
style: simple
responses:
@@ -29083,18 +26600,8 @@ paths:
content:
application/json:
schema:
- format: binary
- type: string
- application/x-protobuf:
- schema:
- format: binary
- type: string
- application/octet-stream:
- schema:
- format: binary
- type: string
- description: Expected response once calculation is completed, returns JSON
- in the format specified in the Calculation parameters.
+ $ref: '#/components/schemas/QuantCalculationParametersRoot'
+ description: Expected response, returns the Quant Engine calculation parameters.
headers:
Content-Encoding:
description: Standard HTTP header. Header value based on Accept-Encoding
@@ -29160,12 +26667,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/octet-stream:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
@@ -29207,14 +26708,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/octet-stream:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation was already returned, provided id was not a requested
- calculation, or the calculation was cancelled
+ description: Calculation id not found
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -29345,82 +26839,61 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Quant Engine calculation result by id
+ summary: Get Quant Engine calculation parameters by id
tags:
- QuantCalculations
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- is-file: true
+ response-type: QuantCalculationParametersRoot
x-accepts: application/json
- /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/info:
- get:
- description: This is the endpoint to get the metadata information of a previously
- requested calculation.
- operationId: getCalculationUnitInfoById
+ put:
+ description: "This endpoint updates and runs the Quant Engine calculation specified\
+ \ in the PUT body parameters. This also allows creating new Quant Engine calculations\
+ \ with custom ids.\r\nIt can take one or more calculation units as input."
+ operationId: putAndCalculate
parameters:
- - description: from url, provided from the location header in the Get Quant
- calculation status by id endpoint
+ - description: from url, provided from the location header in the Create and
+ Run Quant Engine calculation endpoint
explode: false
in: path
name: id
required: true
schema:
- description: from url, provided from the location header in the Get Quant
- calculation status by id endpoint
+ description: from url, provided from the location header in the Create and
+ Run Quant Engine calculation endpoint
type: string
style: simple
- - description: from url, provided from the location header in the Get Quant
- calculation status by id endpoint
+ - description: Standard HTTP header. Accepts no-store, max-age, max-stale.
explode: false
- in: path
- name: unitId
- required: true
+ in: header
+ name: Cache-Control
+ required: false
schema:
- description: from url, provided from the location header in the Get Quant
- calculation status by id endpoint
type: string
style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/QuantCalculationParametersRoot'
+ description: Calculation Parameters
responses:
- "200":
+ "202":
content:
application/json:
schema:
- format: binary
- type: string
+ $ref: '#/components/schemas/CalculationStatusRoot'
application/x-protobuf:
schema:
- format: binary
- type: string
- application/octet-stream:
- schema:
- format: binary
- type: string
- description: Expected response once calculation is completed.
+ $ref: '#/components/schemas/CalculationStatusRoot'
+ description: Expected response, contains the poll URL in the Location header.
headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
- explode: false
- schema:
- description: Standard HTTP header.
- type: string
- style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
+ Location:
+ description: URL to poll for the resulting calculation
explode: false
schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
+ description: URL to poll for the resulting calculation
type: string
style: simple
X-DataDirect-Request-Key:
@@ -29457,18 +26930,16 @@ paths:
schema:
type: string
style: simple
- "400":
+ "200":
content:
application/json:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
+ $ref: '#/components/schemas/CalculationStatusRoot'
application/x-protobuf:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/octet-stream:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ $ref: '#/components/schemas/CalculationStatusRoot'
+ description: Expected response if the calculation has one unit and is completed
+ with an error.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -29504,19 +26975,17 @@ paths:
schema:
type: string
style: simple
- "404":
+ "201":
content:
application/json:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
+ $ref: '#/components/schemas/ObjectRoot'
application/x-protobuf:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/octet-stream:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation was already returned, provided id was not a requested
- calculation, or the calculation was cancelled
+ $ref: '#/components/schemas/ObjectRoot'
+ description: Expected response if the calculation has one unit and is completed
+ in a short span, returns JSON in the format specified in the Calculation
+ parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -29552,27 +27021,15 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
+ "400":
+ content:
+ application/json:
schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/x-protobuf:
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid Calculation Parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -29594,88 +27051,29 @@ paths:
description: Number of allowed requests for the time window.
explode: false
schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
type: string
style: simple
- summary: Get Quant Engine calculation metadata information by id
- tags:
- - QuantCalculations
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- is-file: true
- x-accepts: application/json
- /analytics/engines/spar/v3/calculations:
- get:
- description: This endpoints returns all calculation requests.
- operationId: getAllCalculations
- parameters:
- - explode: true
- in: query
- name: pageNumber
- required: true
- schema:
- default: 1
- format: int32
- type: integer
- style: form
- responses:
- "200":
+ "404":
content:
application/json:
schema:
- $ref: '#/components/schemas/CalculationsSummaryRoot'
- description: List of calculation requests.
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: One or more calculation settings were unavailable.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -29711,12 +27109,15 @@ paths:
schema:
type: string
style: simple
- "400":
+ "409":
content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid page number.
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Duplicate calculation exists with same parameters.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -29752,12 +27153,15 @@ paths:
schema:
type: string
style: simple
- "404":
+ "413":
content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: No calculation found.
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Request body too large
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -29813,7 +27217,7 @@ paths:
type: string
style: simple
"403":
- description: User is forbidden with current credentials.
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -29849,8 +27253,9 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ "415":
+ description: Missing/Invalid Content-Type header. Header needs to be set
+ to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -29887,8 +27292,8 @@ paths:
type: string
style: simple
"429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
+ description: Rate limit reached. Cancel older requests using Cancel Calculation
+ endpoint or wait for older requests to finish/expire.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -29906,6 +27311,24 @@ paths:
available after successful authentication.
type: string
style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
Retry-After:
description: Time to wait in seconds before making a new request as
the rate limit has reached.
@@ -29952,60 +27375,70 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get all calculations
+ summary: Create or update Quant Engine calculation and run it.
tags:
- - SPARCalculations
- x-are-multiple-success-responses-different: false
+ - QuantCalculations
+ x-are-multiple-success-responses-different: true
x-success-response-types:
+ - status-code: "202"
+ response-type: CalculationStatusRoot
- status-code: "200"
- response-type: CalculationsSummaryRoot
+ response-type: CalculationStatusRoot
+ - status-code: "201"
+ response-type: ObjectRoot
+ x-contentType: application/json
x-accepts: application/json
- post:
- description: "This endpoint runs the SPAR calculation specified in the POST\
- \ body parameters.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\
- \n\r\n*\tAny settings in POST body will act as a one-time override over the\
- \ settings saved in the SPAR template."
- operationId: postAndCalculate
+ /analytics/engines/quant/v3/calculations/{id}/status:
+ get:
+ description: "This is the endpoint to check on the progress of a previously\
+ \ requested calculation.\r\nIf the calculation has finished computing, the\
+ \ location header will point to the result url.\r\nOtherwise, the calculation\
+ \ is still running and the X-FactSet-Api-PickUp-Progress header will contain\
+ \ a progress percentage."
+ operationId: getCalculationStatusById
parameters:
- - description: Long running deadline in seconds when only one unit is passed
- in the POST body.
- explode: false
- in: header
- name: X-FactSet-Api-Long-Running-Deadline
- required: false
- schema:
- type: integer
- style: simple
- - description: Standard HTTP header. Accepts max-stale.
+ - description: from url, provided from the location header in the Create and
+ Run Quant Engine calculation endpoint
explode: false
- in: header
- name: Cache-Control
- required: false
+ in: path
+ name: id
+ required: true
schema:
+ description: from url, provided from the location header in the Create and
+ Run Quant Engine calculation endpoint
type: string
style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SPARCalculationParametersRoot'
- description: Calculation Parameters
responses:
- "202":
+ "200":
content:
application/json:
schema:
$ref: '#/components/schemas/CalculationStatusRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response, contains the poll URL in the Location header.
+ description: Expected response once calculation is completed.
headers:
- Location:
- description: URL to poll for the resulting calculation
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
explode: false
schema:
- description: URL to poll for the resulting calculation
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ type: string
+ style: simple
+ Content-Type:
+ description: Standard HTTP header.
+ explode: false
+ schema:
+ description: Standard HTTP header.
+ type: string
+ style: simple
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
type: string
style: simple
X-DataDirect-Request-Key:
@@ -30042,17 +27475,30 @@ paths:
schema:
type: string
style: simple
- "200":
+ "202":
content:
application/json:
schema:
$ref: '#/components/schemas/CalculationStatusRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response, if the calculation has one unit and is completed
- with an error.
+ description: Expected response returned if the calculation is not yet completed,
+ should contain X-FactSet-Api-PickUp-Progress header.
headers:
+ X-FactSet-Api-PickUp-Progress:
+ description: FactSet's progress header.
+ explode: false
+ schema:
+ description: FactSet's progress header.
+ type: string
+ style: simple
+ Cache-Control:
+ description: Standard HTTP header. Header will specify max-age in seconds.
+ Polling can be adjusted based on the max-age value.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header will specify max-age in
+ seconds. Polling can be adjusted based on the max-age value.
+ type: integer
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -30087,17 +27533,12 @@ paths:
schema:
type: string
style: simple
- "201":
+ "400":
content:
application/json:
schema:
- $ref: '#/components/schemas/ObjectRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response if the calculation has one unit and is completed
- in a short span, returns JSON in the format specified in the Calculation
- parameters.
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30133,15 +27574,13 @@ paths:
schema:
type: string
style: simple
- "400":
+ "404":
content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid calculation parameters.
+ description: Calculation was already returned, provided id was not a requested
+ calculation, or the calculation was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30177,15 +27616,27 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: One or more calculation settings were unavailable.
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30221,8 +27672,9 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30240,9 +27692,107 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ summary: Get Quant Engine calculation status by id
+ tags:
+ - QuantCalculations
+ x-are-multiple-success-responses-different: false
+ x-success-response-types:
+ - status-code: "200"
+ response-type: CalculationStatusRoot
+ - status-code: "202"
+ response-type: CalculationStatusRoot
+ x-accepts: application/json
+ /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/result:
+ get:
+ description: "This is the endpoint to get the result of a previously requested\
+ \ calculation.\r\nIf the calculation has finished computing, the body of the\
+ \ response will contain the requested document in JSON."
+ operationId: getCalculationUnitResultById
+ parameters:
+ - description: from url, provided from the location header in the Get Quant
+ Engine calculation status by id endpoint
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: from url, provided from the location header in the Get Quant
+ Engine calculation status by id endpoint
+ type: string
+ style: simple
+ - description: from url, provided from the location header in the Get Quant
+ Engine calculation status by id endpoint
+ explode: false
+ in: path
+ name: unitId
+ required: true
+ schema:
+ description: from url, provided from the location header in the Get Quant
+ Engine calculation status by id endpoint
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ format: binary
+ type: string
+ application/x-protobuf:
+ schema:
+ format: binary
+ type: string
+ application/octet-stream:
+ schema:
+ format: binary
+ type: string
+ description: Expected response once calculation is completed, returns JSON
+ in the format specified in the Calculation parameters.
headers:
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ type: string
+ style: simple
+ Content-Type:
+ description: Standard HTTP header.
+ explode: false
+ schema:
+ description: Standard HTTP header.
+ type: string
+ style: simple
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -30277,9 +27827,18 @@ paths:
schema:
type: string
style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/octet-stream:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid identifier provided.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30315,9 +27874,19 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Cancel older requests using Cancel Calculation
- endpoint or wait for older requests to finish/expire.
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/x-protobuf:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/octet-stream:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Calculation was already returned, provided id was not a requested
+ calculation, or the calculation was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30353,16 +27922,65 @@ paths:
schema:
type: string
style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
type: string
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30399,39 +28017,84 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create and Run SPAR calculation
+ summary: Get Quant Engine calculation result by id
tags:
- - SPARCalculations
- x-are-multiple-success-responses-different: true
+ - QuantCalculations
+ x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "202"
- response-type: CalculationStatusRoot
- status-code: "200"
- response-type: CalculationStatusRoot
- - status-code: "201"
- response-type: ObjectRoot
- x-contentType: application/json
+ is-file: true
x-accepts: application/json
- /analytics/engines/spar/v3/calculations/{id}:
- delete:
- description: This is the endpoint to cancel a previously submitted calculation.
- operationId: cancelCalculationById
+ /analytics/engines/quant/v3/calculations/{id}/units/{unitId}/info:
+ get:
+ description: This is the endpoint to get the metadata information of a previously
+ requested calculation.
+ operationId: getCalculationUnitInfoById
parameters:
- - description: from url, provided from the location header in the Create and
- Run SPAR calculation endpoint
+ - description: from url, provided from the location header in the Get Quant
+ calculation status by id endpoint
explode: false
in: path
name: id
required: true
schema:
- description: from url, provided from the location header in the Create and
- Run SPAR calculation endpoint
+ description: from url, provided from the location header in the Get Quant
+ calculation status by id endpoint
+ type: string
+ style: simple
+ - description: from url, provided from the location header in the Get Quant
+ calculation status by id endpoint
+ explode: false
+ in: path
+ name: unitId
+ required: true
+ schema:
+ description: from url, provided from the location header in the Get Quant
+ calculation status by id endpoint
type: string
style: simple
responses:
- "204":
- description: Expected response, calculation was canceled successfully.
+ "200":
+ content:
+ application/json:
+ schema:
+ format: binary
+ type: string
+ application/x-protobuf:
+ schema:
+ format: binary
+ type: string
+ application/octet-stream:
+ schema:
+ format: binary
+ type: string
+ description: Expected response once calculation is completed.
headers:
+ Content-Encoding:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value based on Accept-Encoding
+ Request header.
+ type: string
+ style: simple
+ Content-Type:
+ description: Standard HTTP header.
+ explode: false
+ schema:
+ description: Standard HTTP header.
+ type: string
+ style: simple
+ Transfer-Encoding:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ explode: false
+ schema:
+ description: Standard HTTP header. Header value will be set to Chunked
+ if Accept-Encoding header is specified.
+ type: string
+ style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -30468,13 +28131,13 @@ paths:
style: simple
"400":
content:
- text/plain:
+ application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/json:
+ application/x-protobuf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- text/json:
+ application/octet-stream:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
description: Invalid identifier provided.
@@ -30515,17 +28178,17 @@ paths:
style: simple
"404":
content:
- text/plain:
+ application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/json:
+ application/x-protobuf:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- text/json:
+ application/octet-stream:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: There was no request for the calculation identifier provided,
- or the request was already canceled for the provided identifier.
+ description: Calculation was already returned, provided id was not a requested
+ calculation, or the calculation was cancelled
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30619,7 +28282,7 @@ paths:
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
+ in troubleshooting
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30656,62 +28319,31 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Cancel SPAR calculation
+ summary: Get Quant Engine calculation metadata information by id
tags:
- - SPARCalculations
+ - QuantCalculations
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "204"
+ - status-code: "200"
+ is-file: true
x-accepts: application/json
- get:
- description: This is the endpoint that returns the calculation parameters passed
- for a calculation.
- operationId: getCalculationParameters
- parameters:
- - description: from url, provided from the location header in the Create and
- Run SPAR calculation endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Create and
- Run SPAR calculation endpoint
- type: string
- style: simple
+ /analytics/security-modeling/v3/securities/retrieve:
+ post:
+ description: This endpoint gets all existing securities.
+ operationId: getSecurities
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SMRetrieveParametersRoot'
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/SPARCalculationParametersRoot'
- description: Expected response, returns the SPAR calculation parameters.
+ $ref: '#/components/schemas/SMRetrieveResponseRoot'
+ description: Expected response, returns a list of existing securities.
headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
- explode: false
- schema:
- description: Standard HTTP header.
- type: string
- style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- explode: false
- schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -30746,12 +28378,27 @@ paths:
schema:
type: string
style: simple
- "400":
- content:
- application/json:
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30787,12 +28434,8 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation id not found
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30828,27 +28471,9 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30866,27 +28491,16 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
explode: false
schema:
type: string
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -30923,74 +28537,33 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get SPAR calculation parameters by id
+ summary: Get existing securities
tags:
- - SPARCalculations
+ - SecurityModeling
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: SPARCalculationParametersRoot
+ response-type: SMRetrieveResponseRoot
+ x-contentType: application/json
x-accepts: application/json
- put:
- description: "This endpoint updates and run the SPAR calculation specified in\
- \ the PUT body parameters. This also allows creating new SPAR calculations\
- \ with custom ids.\r\nIt can take one or more units as input.\r\n\r\nRemarks:\r\
- \n\r\n*\tAny settings in PUT body will act as a one-time override over the\
- \ settings saved in the SPAR template."
- operationId: putAndCalculate
- parameters:
- - description: from url, provided from the location header in the Create and
- Run SPAR calculation endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Create and
- Run SPAR calculation endpoint
- type: string
- style: simple
- - description: Long running deadline in seconds when only one unit is passed
- in the PUT body.
- explode: false
- in: header
- name: X-FactSet-Api-Long-Running-Deadline
- required: false
- schema:
- type: integer
- style: simple
- - description: Standard HTTP header. Accepts max-stale.
- explode: false
- in: header
- name: Cache-Control
- required: false
- schema:
- type: string
- style: simple
+ /analytics/security-modeling/v3/securities/upsert:
+ post:
+ description: This endpoint is to create or update existing securities.
+ operationId: upsertSecurities
requestBody:
content:
application/json:
schema:
- $ref: '#/components/schemas/SPARCalculationParametersRoot'
- description: Calculation Parameters
+ $ref: '#/components/schemas/SMCreateParametersRoot'
responses:
- "202":
+ "200":
content:
application/json:
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response, contains the poll URL in the Location header.
+ $ref: '#/components/schemas/SMCreateResponseRoot'
+ description: Expected response, returns a status of operation along with
+ errors and warnings if found any.
headers:
- Location:
- description: URL to poll for the resulting calculation
- explode: false
- schema:
- description: URL to poll for the resulting calculation
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -31025,16 +28598,27 @@ paths:
schema:
type: string
style: simple
- "200":
- content:
- application/json:
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- application/x-protobuf:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response, if the calculation has one unit and is completed
- with an error.
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31070,17 +28654,8 @@ paths:
schema:
type: string
style: simple
- "201":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response if the calculation has one unit and is completed
- in a short span, returns JSON in the format specified in the Calculation
- parameters.
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31116,15 +28691,9 @@ paths:
schema:
type: string
style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid Calculation Parameters.
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31142,33 +28711,16 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
explode: false
schema:
type: string
style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: One or more calculation settings were unavailable.
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31186,33 +28738,50 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
- "409":
+ summary: Create or update securities
+ tags:
+ - SecurityModeling
+ x-are-multiple-success-responses-different: false
+ x-success-response-types:
+ - status-code: "200"
+ response-type: SMCreateResponseRoot
+ x-contentType: application/json
+ x-accepts: application/json
+ /analytics/security-modeling/v3/securities/delete:
+ post:
+ description: This endpoint deletes existing securities.
+ operationId: deleteSecurities
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SMDeleteParametersRoot'
+ responses:
+ "200":
content:
application/json:
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Duplicate calculation exists with same parameters.
+ $ref: '#/components/schemas/SMDeleteResponseRoot'
+ description: Expected response, deletes existing securities.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31304,9 +28873,8 @@ paths:
schema:
type: string
style: simple
- "415":
- description: Missing/Invalid Content-Type header. Header needs to be set
- to application/json.
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31343,8 +28911,8 @@ paths:
type: string
style: simple
"429":
- description: Rate limit reached. Cancel older requests using Cancel Calculation
- endpoint or wait for older requests to finish/expire.
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31362,24 +28930,6 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
Retry-After:
description: Time to wait in seconds before making a new request as
the rate limit has reached.
@@ -31426,35 +28976,27 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create or Update SPAR calculation and run it.
+ summary: Delete existing securities
tags:
- - SPARCalculations
- x-are-multiple-success-responses-different: true
+ - SecurityModeling
+ x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "202"
- response-type: CalculationStatusRoot
- status-code: "200"
- response-type: CalculationStatusRoot
- - status-code: "201"
- response-type: ObjectRoot
+ response-type: SMDeleteResponseRoot
x-contentType: application/json
x-accepts: application/json
- /analytics/engines/spar/v3/calculations/{id}/status:
+ /analytics/security-modeling/v3/templates/{template}/fields:
get:
- description: "This is the endpoint to check on the progress of a previously\
- \ requested calculation.\r\nIf the calculation has finished computing, the\
- \ location header will point to the result url."
- operationId: getCalculationStatusById
+ description: This endpoint gets template fields.
+ operationId: getTemplateFields
parameters:
- - description: from url, provided from the location header in the Create and
- Run SPAR calculation endpoint
+ - description: Template name
explode: false
in: path
- name: id
+ name: template
required: true
schema:
- description: from url, provided from the location header in the Create and
- Run SPAR calculation endpoint
+ description: Template name
type: string
style: simple
responses:
@@ -31462,34 +29004,9 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response once calculation is completed.
+ $ref: '#/components/schemas/SMTemplateFieldPropertiesRoot'
+ description: Expected response, returns a list of all template fields.
headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- explode: false
- schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
- type: string
- style: simple
- Content-Type:
- description: Standard HTTP header.
- explode: false
- schema:
- description: Standard HTTP header.
- type: string
- style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- explode: false
- schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
- type: string
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -31524,29 +29041,13 @@ paths:
schema:
type: string
style: simple
- "202":
+ "400":
content:
application/json:
schema:
- $ref: '#/components/schemas/CalculationStatusRoot'
- description: Expected response returned if the calculation is not yet completed.
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid template.
headers:
- X-FactSet-Api-PickUp-Progress:
- description: FactSet's progress header.
- explode: false
- schema:
- description: FactSet's progress header.
- type: string
- style: simple
- Cache-Control:
- description: Standard HTTP header. Header will specify max-age in seconds.
- Polling can be adjusted based on the max-age value.
- explode: false
- schema:
- description: Standard HTTP header. Header will specify max-age in
- seconds. Polling can be adjusted based on the max-age value.
- type: integer
- style: simple
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -31581,12 +29082,12 @@ paths:
schema:
type: string
style: simple
- "400":
+ "404":
content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ description: Template not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31622,13 +29123,27 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation was already returned, provided id was not a requested
- calculation, or the calculation was cancelled
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31664,8 +29179,8 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31683,8 +29198,27 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31702,27 +29236,16 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
explode: false
schema:
type: string
style: simple
"500":
description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ in troubleshooting.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31759,43 +29282,30 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get SPAR calculation status by id
+ summary: Get template fields
tags:
- - SPARCalculations
+ - SecurityModeling
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: CalculationStatusRoot
- - status-code: "202"
- response-type: CalculationStatusRoot
+ response-type: SMTemplateFieldPropertiesRoot
x-accepts: application/json
- /analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result:
+ /analytics/engines/axp/v3/strategies/{path}:
get:
- description: "This is the endpoint to get the result of a previously requested\
- \ calculation.\r\nIf the calculation has finished computing, the body of the\
- \ response will contain the requested document in JSON."
- operationId: getCalculationUnitResultById
+ description: This endpoint looks up all Axioma Equity strategy documents and
+ sub-directories in a given directory.
+ operationId: getAxiomaEquityStrategyDocuments
parameters:
- - description: from url, provided from the location header in the Get SPAR calculation
- status by id endpoint
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: from url, provided from the location header in the Get SPAR
- calculation status by id endpoint
- type: string
- style: simple
- - description: from url, provided from the location header in the Get SPAR calculation
- status by id endpoint
+ - description: The directory to get the strategy documents and sub-directories
+ in
explode: false
in: path
- name: unitId
+ name: path
required: true
schema:
- description: from url, provided from the location header in the Get SPAR
- calculation status by id endpoint
+ default: ""
+ description: The directory to get the strategy documents and sub-directories
+ in
type: string
style: simple
responses:
@@ -31803,38 +29313,51 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/ObjectRoot'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ObjectRoot'
- description: Expected response once calculation is completed, returns JSON
- in the format specified in the Calculation parameters.
+ $ref: '#/components/schemas/DocumentDirectoriesRoot'
+ description: Expected response, returns a list of Axioma Equity strategy
+ documents and directories
headers:
- Content-Encoding:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
- description: Standard HTTP header. Header value based on Accept-Encoding
- Request header.
+ description: FactSet's request key header.
type: string
style: simple
- Content-Type:
- description: Standard HTTP header.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
- description: Standard HTTP header.
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
- Transfer-Encoding:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
explode: false
schema:
- description: Standard HTTP header. Header value will be set to Chunked
- if Accept-Encoding header is specified.
type: string
style: simple
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid query parameter or value provided
+ headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
explode: false
@@ -31869,15 +29392,12 @@ paths:
schema:
type: string
style: simple
- "400":
+ "404":
content:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid identifier provided.
+ description: Path not found
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31913,16 +29433,64 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
+ "401":
+ description: Missing or invalid authentication
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- application/x-protobuf:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Calculation was already returned, provided id was not a requested
- calculation, or the calculation was cancelled
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31958,27 +29526,9 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -31996,20 +29546,9 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
explode: false
schema:
type: string
@@ -32035,7 +29574,7 @@ paths:
type: string
style: simple
"503":
- description: Request timed out. Retry the request in sometime.
+ description: Request timed out. Retry the request in some time
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -32053,19 +29592,19 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get SPAR calculation result by id
+ summary: Get Axioma Equity strategy documents and sub-directories in a directory
tags:
- - SPARCalculations
+ - StrategyDocuments
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: ObjectRoot
+ response-type: DocumentDirectoriesRoot
x-accepts: application/json
- /analytics/engines/axp/v3/strategies/{path}:
+ /analytics/engines/afi/v3/strategies/{path}:
get:
- description: This endpoint looks up all Axioma Equity strategy documents and
- sub-directories in a given directory.
- operationId: getAxiomaEquityStrategyDocuments
+ description: This endpoint looks up all Axioma FI strategy documents and sub-directories
+ in a given directory.
+ operationId: getAxiomaFIStrategyDocuments
parameters:
- description: The directory to get the strategy documents and sub-directories
in
@@ -32085,8 +29624,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/DocumentDirectoriesRoot'
- description: Expected response, returns a list of Axioma Equity strategy
- documents and directories
+ description: Expected response, returns a list of Axioma FI strategy documents
+ and directories
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -32363,7 +29902,7 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Axioma Equity strategy documents and sub-directories in a directory
+ summary: Get Axioma FI strategy documents and sub-directories in a directory
tags:
- StrategyDocuments
x-are-multiple-success-responses-different: false
@@ -32371,11 +29910,11 @@ paths:
- status-code: "200"
response-type: DocumentDirectoriesRoot
x-accepts: application/json
- /analytics/engines/afi/v3/strategies/{path}:
+ /analytics/engines/bpm/v3/strategies/{path}:
get:
- description: This endpoint looks up all Axioma FI strategy documents and sub-directories
+ description: This endpoint looks up all Barra strategy documents and sub-directories
in a given directory.
- operationId: getAxiomaFIStrategyDocuments
+ operationId: getBarraStrategyDocuments
parameters:
- description: The directory to get the strategy documents and sub-directories
in
@@ -32395,7 +29934,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/DocumentDirectoriesRoot'
- description: Expected response, returns a list of Axioma FI strategy documents
+ description: Expected response, returns a list of Barra strategy documents
and directories
headers:
X-DataDirect-Request-Key:
@@ -32673,7 +30212,7 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Axioma FI strategy documents and sub-directories in a directory
+ summary: Get Barra strategy documents and sub-directories in a directory
tags:
- StrategyDocuments
x-are-multiple-success-responses-different: false
@@ -32681,11 +30220,11 @@ paths:
- status-code: "200"
response-type: DocumentDirectoriesRoot
x-accepts: application/json
- /analytics/engines/bpm/v3/strategies/{path}:
+ /analytics/engines/npo/v3/strategies/{path}:
get:
- description: This endpoint looks up all Barra strategy documents and sub-directories
+ description: This endpoint looks up all Northfield strategy documents and sub-directories
in a given directory.
- operationId: getBarraStrategyDocuments
+ operationId: getNorthfieldStrategyDocuments
parameters:
- description: The directory to get the strategy documents and sub-directories
in
@@ -32705,7 +30244,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/DocumentDirectoriesRoot'
- description: Expected response, returns a list of Barra strategy documents
+ description: Expected response, returns a list of Northfield strategy documents
and directories
headers:
X-DataDirect-Request-Key:
@@ -32983,7 +30522,7 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Barra strategy documents and sub-directories in a directory
+ summary: Get Northfield strategy documents and sub-directories in a directory
tags:
- StrategyDocuments
x-are-multiple-success-responses-different: false
@@ -32991,11 +30530,11 @@ paths:
- status-code: "200"
response-type: DocumentDirectoriesRoot
x-accepts: application/json
- /analytics/engines/npo/v3/strategies/{path}:
+ /analytics/engines/fpo/v3/strategies/{path}:
get:
- description: This endpoint looks up all Northfield strategy documents and sub-directories
- in a given directory.
- operationId: getNorthfieldStrategyDocuments
+ description: This endpoint looks up all FactSet Portfolio Optimizer strategy
+ documents and sub-directories in a given directory.
+ operationId: getFPOStrategyDocuments
parameters:
- description: The directory to get the strategy documents and sub-directories
in
@@ -33015,8 +30554,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/DocumentDirectoriesRoot'
- description: Expected response, returns a list of Northfield strategy documents
- and directories
+ description: Expected response, returns a list of FactSet Portfolio Optimizer
+ strategy documents and directories
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -33293,7 +30832,8 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get Northfield strategy documents and sub-directories in a directory
+ summary: Get FactSet Portfolio Optimizer strategy documents and sub-directories
+ in a directory
tags:
- StrategyDocuments
x-are-multiple-success-responses-different: false
@@ -33301,32 +30841,28 @@ paths:
- status-code: "200"
response-type: DocumentDirectoriesRoot
x-accepts: application/json
- /analytics/engines/fpo/v3/strategies/{path}:
+ /analytics/engines/pa/v3/templated-components:
get:
- description: This endpoint looks up all FactSet Portfolio Optimizer strategy
- documents and sub-directories in a given directory.
- operationId: getFPOStrategyDocuments
+ description: This endpoint returns the list of templated PA components in path.
+ operationId: getTemplatedPAComponentsInPath
parameters:
- - description: The directory to get the strategy documents and sub-directories
- in
- explode: false
- in: path
- name: path
+ - description: Get templated PA components in path
+ explode: true
+ in: query
+ name: directory
required: true
schema:
- default: ""
- description: The directory to get the strategy documents and sub-directories
- in
+ description: Get templated PA components in path
+ example: Personal:TemplatedPAComponents/
type: string
- style: simple
+ style: form
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/DocumentDirectoriesRoot'
- description: Expected response, returns a list of FactSet Portfolio Optimizer
- strategy documents and directories
+ $ref: '#/components/schemas/TemplatedPAComponentSummaryRoot'
+ description: Expected response, returns a list templated PA components.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -33367,7 +30903,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid query parameter or value provided
+ description: Invalid data provided. Please check the request parameters
+ before attempting again.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -33403,12 +30940,27 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Path not found
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -33444,8 +30996,8 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -33463,8 +31015,27 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -33482,26 +31053,94 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
explode: false
schema:
type: string
style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
explode: false
schema:
+ description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
explode: false
schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ summary: Get templated PA components in path
+ tags:
+ - TemplatedPAComponents
+ x-are-multiple-success-responses-different: false
+ x-success-response-types:
+ - status-code: "200"
+ response-type: TemplatedPAComponentSummaryRoot
+ x-accepts: application/json
+ post:
+ description: "This endpoint creates new component based off of linked PA template\
+ \ or unlinked PA template.\r\n\r\nRemarks:\r\n\r\n* Any settings in the\
+ \ POST body will act as a one-time override over the settings saved in the\
+ \ PA template.\r\n\r\n* Multi-horizon frequencies are not supported through\
+ \ this endpoint.\r\n\r\n* Componentdetail supports securities, groups, and\
+ \ totals as well but if we don't pass anything that defaults to securities.\r\
+ \n\r\n* If we are overriding the grouping with a frequency, we will be overriding\
+ \ the grouping saved to the original component and also overriding \r\n \
+ \ the default frequency of the Beginning of Period to whatever we pass in\
+ \ the request body.\r\n \r\n* If we are overriding gouping frequency\
+ \ without overriding the group id it will not be applied to the default groupings\
+ \ saved to the original component."
+ operationId: createTemplatedPAComponents
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TemplatedPAComponentParametersRoot'
+ description: Request Parameters
+ required: true
+ responses:
+ "201":
+ content:
+ text/plain:
+ schema:
+ $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot'
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot'
+ text/json:
+ schema:
+ $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot'
+ description: Expected response, templated PA component created successfully.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -33537,36 +31176,19 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
+ "400":
+ content:
+ text/plain:
schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/json:
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
+ $ref: '#/components/schemas/ClientErrorResponse'
+ text/json:
schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid data provided. Please check the request parameters
+ before attempting again.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -33584,55 +31206,26 @@ paths:
available after successful authentication.
type: string
style: simple
- "503":
- description: Request timed out. Retry the request in some time
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
explode: false
schema:
- description: FactSet's request key header.
type: string
style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
explode: false
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
type: string
style: simple
- summary: Get FactSet Portfolio Optimizer strategy documents and sub-directories
- in a directory
- tags:
- - StrategyDocuments
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: DocumentDirectoriesRoot
- x-accepts: application/json
- /analytics/engines/pa/v3/templated-components:
- get:
- description: This endpoint returns the list of templated PA components in path.
- operationId: getTemplatedPAComponentsInPath
- parameters:
- - description: Get templated PA components in path
- explode: true
- in: query
- name: directory
- required: true
- schema:
- description: Get templated PA components in path
- type: string
- style: form
- responses:
- "200":
- content:
- application/json:
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
schema:
- $ref: '#/components/schemas/TemplatedPAComponentSummaryRoot'
- description: Expected response, returns a list templated PA components.
+ type: string
+ style: simple
+ "401":
+ description: Missing or invalid authentication.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -33650,31 +31243,8 @@ paths:
available after successful authentication.
type: string
style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "400":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid data provided. Please check the request parameters
- before attempting again.
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -33710,27 +31280,8 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ "404":
+ description: Template not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -33869,48 +31420,33 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get templated PA components in path
+ summary: Create templated PA component
tags:
- TemplatedPAComponents
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "200"
- response-type: TemplatedPAComponentSummaryRoot
+ - status-code: "201"
+ response-type: TemplatedPAComponentPostSummaryRoot
+ x-contentType: application/json
x-accepts: application/json
- post:
- description: "This endpoint creates new component based off of linked PA template\
- \ or unlinked PA template.\r\n\r\nRemarks:\r\n\r\n* Any settings in the\
- \ POST body will act as a one-time override over the settings saved in the\
- \ PA template.\r\n\r\n* Multi-horizon frequencies are not supported through\
- \ this endpoint.\r\n\r\n* Componentdetail supports securities, groups, and\
- \ totals as well but if we don't pass anything that defaults to securities.\r\
- \n\r\n* If we are overriding the grouping with a frequency, we will be overriding\
- \ the grouping saved to the original component and also overriding \r\n \
- \ the default frequency of the Beginning of Period to whatever we pass in\
- \ the request body.\r\n \r\n* If we are overriding gouping frequency\
- \ without overriding the group id it will not be applied to the default groupings\
- \ saved to the original component."
- operationId: createTemplatedPAComponents
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TemplatedPAComponentParametersRoot'
- description: Request Parameters
+ /analytics/engines/pa/v3/templated-components/{id}:
+ delete:
+ description: This endpoint deletes an existing templated PA component
+ operationId: deleteTemplatedPAComponents
+ parameters:
+ - description: Unique identifier for a templated PA component
+ explode: false
+ in: path
+ name: id
required: true
+ schema:
+ description: Unique identifier for a templated PA component
+ example: "01234567890123456789012345678901"
+ type: string
+ style: simple
responses:
- "201":
- content:
- text/plain:
- schema:
- $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot'
- application/json:
- schema:
- $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot'
- text/json:
- schema:
- $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot'
- description: Expected response, templated PA component created successfully.
+ "204":
+ description: Expected response, deleted the templated PA component successfully.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -33994,27 +31530,18 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
+ "404":
+ content:
+ text/plain:
schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
+ $ref: '#/components/schemas/ClientErrorResponse'
+ application/json:
schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "403":
- description: User is forbidden with current credentials
+ $ref: '#/components/schemas/ClientErrorResponse'
+ text/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Component not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -34050,8 +31577,27 @@ paths:
schema:
type: string
style: simple
- "404":
- description: Template not found.
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -34190,19 +31736,16 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create templated PA component
+ summary: Delete templated PA component
tags:
- TemplatedPAComponents
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "201"
- response-type: TemplatedPAComponentPostSummaryRoot
- x-contentType: application/json
+ - status-code: "204"
x-accepts: application/json
- /analytics/engines/pa/v3/templated-components/{id}:
- delete:
- description: This endpoint deletes an existing templated PA component
- operationId: deleteTemplatedPAComponents
+ get:
+ description: This endpoint fetches the templated PA component settings.
+ operationId: getTemplatedPAComponentById
parameters:
- description: Unique identifier for a templated PA component
explode: false
@@ -34211,11 +31754,16 @@ paths:
required: true
schema:
description: Unique identifier for a templated PA component
+ example: "01234567890123456789012345678901"
type: string
style: simple
responses:
- "204":
- description: Expected response, deleted the templated PA component successfully.
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TemplatedPAComponentRoot'
+ description: Expected response, templated PA component details.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -34253,15 +31801,9 @@ paths:
style: simple
"400":
content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
description: Invalid data provided. Please check the request parameters
before attempting again.
headers:
@@ -34301,16 +31843,10 @@ paths:
style: simple
"404":
content:
- text/plain:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- text/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Component not found.
+ description: Templated PA component not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -34505,16 +32041,28 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Delete templated PA component
+ summary: Get templated PA component by id
tags:
- TemplatedPAComponents
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "204"
+ - status-code: "200"
+ response-type: TemplatedPAComponentRoot
x-accepts: application/json
- get:
- description: This endpoint fetches the templated PA component settings.
- operationId: getTemplatedPAComponentById
+ put:
+ description: "This endpoint allows the user to change the request body from\
+ \ an existing templated PA component.\r\n\r\nRemarks:\r\n\r\n* Any settings\
+ \ in the POST body will act as a one-time override over the settings saved\
+ \ in the PA template.\r\n\r\n* Multi-horizon frequencies are not supported\
+ \ through this endpoint.\r\n\r\n* Componentdetail supports securities, groups,\
+ \ and totals as well but if we don't pass anything that defaults to securities.\r\
+ \n\r\n* If we are overriding the grouping with a frequency, we will be overriding\
+ \ the grouping saved to the original component and also overriding \r\n \
+ \ the default frequency of the Beginning of Period to whatever we pass in\
+ \ the request body.\r\n \r\n* If we are overriding gouping frequency\
+ \ without overriding the group id it will not be applied to the default groupings\
+ \ saved to the original component."
+ operationId: updateTemplatedPAComponents
parameters:
- description: Unique identifier for a templated PA component
explode: false
@@ -34523,15 +32071,23 @@ paths:
required: true
schema:
description: Unique identifier for a templated PA component
+ example: "01234567890123456789012345678901"
type: string
style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TemplatedPAComponentUpdateParametersRoot'
+ description: Request Parameters
+ required: true
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/TemplatedPAComponentRoot'
- description: Expected response, templated PA component details.
+ $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot'
+ description: Expected response, updated successfully.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -34614,7 +32170,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Templated PA component not found.
+ description: Component or template not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -34809,52 +32365,47 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get templated PA component by id
+ summary: Update templated PA component
tags:
- TemplatedPAComponents
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: TemplatedPAComponentRoot
+ response-type: TemplatedPAComponentPostSummaryRoot
+ x-contentType: application/json
x-accepts: application/json
- put:
- description: "This endpoint allows the user to change the request body from\
- \ an existing templated PA component.\r\n\r\nRemarks:\r\n\r\n* Any settings\
- \ in the POST body will act as a one-time override over the settings saved\
- \ in the PA template.\r\n\r\n* Multi-horizon frequencies are not supported\
- \ through this endpoint.\r\n\r\n* Componentdetail supports securities, groups,\
- \ and totals as well but if we don't pass anything that defaults to securities.\r\
- \n\r\n* If we are overriding the grouping with a frequency, we will be overriding\
- \ the grouping saved to the original component and also overriding \r\n \
- \ the default frequency of the Beginning of Period to whatever we pass in\
- \ the request body.\r\n \r\n* If we are overriding gouping frequency\
- \ without overriding the group id it will not be applied to the default groupings\
- \ saved to the original component."
- operationId: updateTemplatedPAComponents
+ /analytics/engines/pa/v3/unlinked-templates:
+ get:
+ description: This endpoint returns the list of unlinked PA templates.
+ operationId: getUnlinkedPATemplates
parameters:
- - description: Unique identifier for a templated PA component
- explode: false
- in: path
- name: id
- required: true
+ - description: Get unlinked PA templates in path.
+ explode: true
+ in: query
+ name: directory
+ required: false
schema:
- description: Unique identifier for a templated PA component
+ description: Get unlinked PA templates in path.
+ example: Personal:UninkedPATemplates/
type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TemplatedPAComponentUpdateParametersRoot'
- description: Request Parameters
- required: true
+ style: form
+ - description: Get unlinked PA templates by category.
+ explode: true
+ in: query
+ name: category
+ required: false
+ schema:
+ description: Get unlinked PA templates by category.
+ example: Weights
+ type: string
+ style: form
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/TemplatedPAComponentPostSummaryRoot'
- description: Expected response, updated successfully.
+ $ref: '#/components/schemas/UnlinkedPATemplateSummaryRoot'
+ description: Expected response, returns a list of unlinked PA templates.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -34932,47 +32483,6 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Component or template not found.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
"401":
description: Missing or invalid authentication.
headers:
@@ -35132,45 +32642,49 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Update templated PA component
+ summary: Get unlinked PA templates
tags:
- - TemplatedPAComponents
+ - UnlinkedPATemplates
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: TemplatedPAComponentPostSummaryRoot
- x-contentType: application/json
+ response-type: UnlinkedPATemplateSummaryRoot
x-accepts: application/json
- /analytics/engines/pa/v3/unlinked-templates:
- get:
- description: This endpoint returns the list of unlinked PA templates.
- operationId: getUnlinkedPATemplates
- parameters:
- - description: Get unlinked PA templates in path.
- explode: true
- in: query
- name: directory
- required: false
- schema:
- description: Get unlinked PA templates in path.
- type: string
- style: form
- - description: Get unlinked PA templates by category.
- explode: true
- in: query
- name: category
- required: false
- schema:
- description: Get unlinked PA templates by category.
- type: string
- style: form
+ post:
+ description: "This endpoint creates a template which is not linked to any specific\
+ \ PA3 tile. \r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be\
+ \ passed in POST requests and Optional fields are not necessary. \r\n If\
+ \ no mandatory fields are passed, then we can use the template as a component\
+ \ and skip the component creation.\r\n \r\n* Mandatory, optional and\
+ \ locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\"\
+ , \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\"\
+ .\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\
+ \n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* \
+ \ Any settings in the POST body will act as a one-time override over the settings\
+ \ saved in the PA template.\r\n\r\n* Multi-horizon frequencies are not supported\
+ \ through this endpoint.\r\n\r\n* Componentdetail supports securities, groups,\
+ \ and totals as well but if we don't pass anything that defaults to securities.\r\
+ \n\r\n* If we are overriding the grouping with a frequency, we will be overriding\
+ \ the grouping saved to the original component and also \r\n overriding\
+ \ the default frequency of the Beginning of Period to whatever we pass in\
+ \ the request body.\r\n \r\n* If we are overriding gouping frequency\
+ \ without overriding the group id it will not be applied to the default groupings\
+ \ saved to the original component."
+ operationId: createUnlinkedPATemplates
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UnlinkedPATemplateParametersRoot'
+ description: Request Parameters
+ required: true
responses:
- "200":
+ "201":
content:
application/json:
schema:
- $ref: '#/components/schemas/UnlinkedPATemplateSummaryRoot'
- description: Expected response, returns a list of unlinked PA templates.
+ $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot'
+ description: Expected response, created a unlinked PA template.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -35407,49 +32921,33 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get unlinked PA templates
+ summary: Create unlinked PA template
tags:
- UnlinkedPATemplates
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "200"
- response-type: UnlinkedPATemplateSummaryRoot
+ - status-code: "201"
+ response-type: UnlinkedPATemplatePostSummaryRoot
+ x-contentType: application/json
x-accepts: application/json
- post:
- description: "This endpoint creates a template which is not linked to any specific\
- \ PA3 tile. \r\n\r\nRemarks:\r\n\r\n* Mandatory fields are required to be\
- \ passed in POST requests and Optional fields are not necessary. \r\n If\
- \ no mandatory fields are passed, then we can use the template as a component\
- \ and skip the component creation.\r\n \r\n* Mandatory, optional and\
- \ locked fields can be \"accounts\", \"benchmarks\", \"groups\", \"columns\"\
- , \"datasources\", \"dates\", \"currencyisocode\" and \"componentdetail\"\
- .\r\n\r\n* We cannot override the Locked fields when creating the Component.\r\
- \n\r\n* Mandatory and locked strings are mutually exclusive.\r\n\r\n* \
- \ Any settings in the POST body will act as a one-time override over the settings\
- \ saved in the PA template.\r\n\r\n* Multi-horizon frequencies are not supported\
- \ through this endpoint.\r\n\r\n* Componentdetail supports securities, groups,\
- \ and totals as well but if we don't pass anything that defaults to securities.\r\
- \n\r\n* If we are overriding the grouping with a frequency, we will be overriding\
- \ the grouping saved to the original component and also \r\n overriding\
- \ the default frequency of the Beginning of Period to whatever we pass in\
- \ the request body.\r\n \r\n* If we are overriding gouping frequency\
- \ without overriding the group id it will not be applied to the default groupings\
- \ saved to the original component."
- operationId: createUnlinkedPATemplates
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UnlinkedPATemplateParametersRoot'
- description: Request Parameters
+ /analytics/engines/pa/v3/unlinked-templates/{id}:
+ delete:
+ description: This endpoint deletes an existing unliked PA template.
+ operationId: deleteUnlinkedPATemplates
+ parameters:
+ - description: Unique identifier for an unlinked PA template
+ explode: false
+ in: path
+ name: id
required: true
+ schema:
+ description: Unique identifier for an unlinked PA template
+ example: "01234567890123456789012345678901"
+ type: string
+ style: simple
responses:
- "201":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot'
- description: Expected response, created a unlinked PA template.
+ "204":
+ description: Expected response, deleted the unlinked PA template successfully.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -35527,6 +33025,47 @@ paths:
schema:
type: string
style: simple
+ "404":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Template not found.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Limit:
+ description: Number of allowed requests for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Remaining:
+ description: Number of requests left for the time window.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ X-FactSet-Api-RateLimit-Reset:
+ description: Number of seconds remaining till rate limit resets.
+ explode: false
+ schema:
+ type: string
+ style: simple
"401":
description: Missing or invalid authentication.
headers:
@@ -35686,19 +33225,16 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Create unlinked PA template
+ summary: Delete unlinked PA template
tags:
- UnlinkedPATemplates
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "201"
- response-type: UnlinkedPATemplatePostSummaryRoot
- x-contentType: application/json
+ - status-code: "204"
x-accepts: application/json
- /analytics/engines/pa/v3/unlinked-templates/{id}:
- delete:
- description: This endpoint deletes an existing unliked PA template.
- operationId: deleteUnlinkedPATemplates
+ get:
+ description: This endpoint fetches the template settings.
+ operationId: getUnlinkedPATemplatesById
parameters:
- description: Unique identifier for an unlinked PA template
explode: false
@@ -35707,11 +33243,16 @@ paths:
required: true
schema:
description: Unique identifier for an unlinked PA template
+ example: "01234567890123456789012345678901"
type: string
style: simple
responses:
- "204":
- description: Expected response, deleted the unlinked PA template successfully.
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UnlinkedPATemplateRoot'
+ description: Expected response, get details of the unlinked PA template.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -35989,16 +33530,35 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Delete unlinked PA template
+ summary: Get unlinked PA template details by id
tags:
- UnlinkedPATemplates
x-are-multiple-success-responses-different: false
x-success-response-types:
- - status-code: "204"
+ - status-code: "200"
+ response-type: UnlinkedPATemplateRoot
x-accepts: application/json
- get:
- description: This endpoint fetches the template settings.
- operationId: getUnlinkedPATemplatesById
+ put:
+ description: "This endpoint updates an existing unlinked PA template.\r\n\r\n\
+ Remarks:\r\n \r\n* Mandatory fields are required to be passed\
+ \ in POST requests and Optional fields are not necessary. \r\n If no mandatory\
+ \ fields are passed, then we can use the template as a component and skip\
+ \ the component creation.\r\n \r\n* Mandatory, optional and locked fields\
+ \ can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\"\
+ , \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot\
+ \ override the Locked fields when creating the Component.\r\n\r\n* Mandatory\
+ \ and locked strings are mutually exclusive.\r\n\r\n* Any settings in the\
+ \ POST body will act as a one-time override over the settings saved in the\
+ \ PA template.\r\n\r\n* Multi-horizon frequencies are not supported through\
+ \ this endpoint.\r\n\r\n* Componentdetail supports securities, groups, and\
+ \ totals as well but if we don't pass anything that defaults to securities.\r\
+ \n\r\n* If we are overriding the grouping with a frequency, we will be overriding\
+ \ the grouping saved to the original component and also overriding \r\n \
+ \ the default frequency of the Beginning of Period to whatever we pass in\
+ \ the request body.\r\n \r\n* If we are overriding gouping frequency\
+ \ without overriding the group id it will not be applied to the default groupings\
+ \ saved to the original component."
+ operationId: updateUnlinkedPATemplates
parameters:
- description: Unique identifier for an unlinked PA template
explode: false
@@ -36007,15 +33567,23 @@ paths:
required: true
schema:
description: Unique identifier for an unlinked PA template
+ example: "01234567890123456789012345678901"
type: string
style: simple
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UnlinkedPATemplateUpdateParametersRoot'
+ description: Request Parameters
+ required: true
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/UnlinkedPATemplateRoot'
- description: Expected response, get details of the unlinked PA template.
+ $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot'
+ description: Expected response, updated the unlinked PA template.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -36293,59 +33861,26 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get unlinked PA template details by id
+ summary: Update unlinked PA template
tags:
- UnlinkedPATemplates
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: UnlinkedPATemplateRoot
+ response-type: UnlinkedPATemplatePostSummaryRoot
+ x-contentType: application/json
x-accepts: application/json
- put:
- description: "This endpoint updates an existing unlinked PA template.\r\n\r\n\
- Remarks:\r\n \r\n* Mandatory fields are required to be passed\
- \ in POST requests and Optional fields are not necessary. \r\n If no mandatory\
- \ fields are passed, then we can use the template as a component and skip\
- \ the component creation.\r\n \r\n* Mandatory, optional and locked fields\
- \ can be \"accounts\", \"benchmarks\", \"groups\", \"columns\", \"datasources\"\
- , \"dates\", \"currencyisocode\" and \"componentdetail\".\r\n\r\n* We cannot\
- \ override the Locked fields when creating the Component.\r\n\r\n* Mandatory\
- \ and locked strings are mutually exclusive.\r\n\r\n* Any settings in the\
- \ POST body will act as a one-time override over the settings saved in the\
- \ PA template.\r\n\r\n* Multi-horizon frequencies are not supported through\
- \ this endpoint.\r\n\r\n* Componentdetail supports securities, groups, and\
- \ totals as well but if we don't pass anything that defaults to securities.\r\
- \n\r\n* If we are overriding the grouping with a frequency, we will be overriding\
- \ the grouping saved to the original component and also overriding \r\n \
- \ the default frequency of the Beginning of Period to whatever we pass in\
- \ the request body.\r\n \r\n* If we are overriding gouping frequency\
- \ without overriding the group id it will not be applied to the default groupings\
- \ saved to the original component."
- operationId: updateUnlinkedPATemplates
- parameters:
- - description: Unique identifier for an unlinked PA template
- explode: false
- in: path
- name: id
- required: true
- schema:
- description: Unique identifier for an unlinked PA template
- type: string
- style: simple
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UnlinkedPATemplateUpdateParametersRoot'
- description: Request Parameters
- required: true
+ /analytics/engines/pa/v3/unlinked-templates/template-types:
+ get:
+ description: This endpoint fetches default unlinked PA template types.
+ operationId: getDefaultUnlinkedPATemplateTypes
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/UnlinkedPATemplatePostSummaryRoot'
- description: Expected response, updated the unlinked PA template.
+ $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot'
+ description: Expected response, default unlinked PA template types
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -36381,13 +33916,27 @@ paths:
schema:
type: string
style: simple
- "400":
- content:
- application/json:
+ "401":
+ description: Missing or invalid authentication.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid data provided. Please check the request parameters
- before attempting again.
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "403":
+ description: User is forbidden with current credentials
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -36423,12 +33972,8 @@ paths:
schema:
type: string
style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Template not found.
+ "406":
+ description: Unsupported Accept header. Header needs to be set to application/json.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -36464,8 +34009,9 @@ paths:
schema:
type: string
style: simple
- "401":
- description: Missing or invalid authentication.
+ "429":
+ description: Rate limit reached. Wait till the time specified in Retry-After
+ header value to make further requests.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -36483,8 +34029,81 @@ paths:
available after successful authentication.
type: string
style: simple
- "403":
- description: User is forbidden with current credentials
+ Retry-After:
+ description: Time to wait in seconds before making a new request as
+ the rate limit has reached.
+ explode: false
+ schema:
+ type: string
+ style: simple
+ "500":
+ description: Server error. Log the X-DataDirect-Request-Key header to assist
+ in troubleshooting.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ "503":
+ description: Request timed out. Retry the request in sometime.
+ headers:
+ X-DataDirect-Request-Key:
+ description: FactSet's request key header.
+ explode: false
+ schema:
+ description: FactSet's request key header.
+ type: string
+ style: simple
+ X-FactSet-Api-Request-Key:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ explode: false
+ schema:
+ description: Key to uniquely identify an Analytics API request. Only
+ available after successful authentication.
+ type: string
+ style: simple
+ summary: Get default unlinked PA template types.
+ tags:
+ - UnlinkedPATemplates
+ x-are-multiple-success-responses-different: false
+ x-success-response-types:
+ - status-code: "200"
+ response-type: UnlinkedPATemplateCategoryAndTypeRoot
+ x-accepts: application/json
+ /analytics/engines/pa/v3/unlinked-templates/template-types/{id}:
+ get:
+ description: This endpoint fetches the unlinked PA template type details.
+ operationId: getDetailsType
+ parameters:
+ - description: Unique identifier for an unlinked PA template type
+ explode: false
+ in: path
+ name: id
+ required: true
+ schema:
+ description: Unique identifier for an unlinked PA template type
+ type: string
+ style: simple
+ responses:
+ "200":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot'
+ description: Expected response, details of the unlinked PA template type
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -36520,8 +34139,13 @@ paths:
schema:
type: string
style: simple
- "406":
- description: Unsupported Accept header. Header needs to be set to application/json.
+ "400":
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Invalid data provided. Please check the request parameters
+ before attempting again.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -36557,92 +34181,12 @@ paths:
schema:
type: string
style: simple
- "429":
- description: Rate limit reached. Wait till the time specified in Retry-After
- header value to make further requests.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- Retry-After:
- description: Time to wait in seconds before making a new request as
- the rate limit has reached.
- explode: false
- schema:
- type: string
- style: simple
- "500":
- description: Server error. Log the X-DataDirect-Request-Key header to assist
- in troubleshooting.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- "503":
- description: Request timed out. Retry the request in sometime.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- summary: Update unlinked PA template
- tags:
- - UnlinkedPATemplates
- x-are-multiple-success-responses-different: false
- x-success-response-types:
- - status-code: "200"
- response-type: UnlinkedPATemplatePostSummaryRoot
- x-contentType: application/json
- x-accepts: application/json
- /analytics/engines/pa/v3/unlinked-templates/template-types:
- get:
- description: This endpoint fetches default unlinked PA template types.
- operationId: getDefaultUnlinkedPATemplateTypes
- responses:
- "200":
+ "404":
content:
application/json:
schema:
- $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeRoot'
- description: Expected response, default unlinked PA template types
+ $ref: '#/components/schemas/ClientErrorResponse'
+ description: Unlinked PA template type not found.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -36837,35 +34381,48 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get default unlinked PA template types.
+ summary: Get unlinked PA template type details by id.
tags:
- UnlinkedPATemplates
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: UnlinkedPATemplateCategoryAndTypeRoot
+ response-type: UnlinkedPATemplateCategoryAndTypeDetailsRoot
x-accepts: application/json
- /analytics/engines/pa/v3/unlinked-templates/template-types/{id}:
- get:
- description: This endpoint fetches the unlinked PA template type details.
- operationId: getDetailsType
+ /analytics/engines/vault/v3/load/{batchId}:
+ post:
+ description: This endpoint loads Vault External Attributions.
+ operationId: vaultAttributionLoader
parameters:
- - description: Unique identifier for an unlinked PA template type
- explode: false
+ - explode: false
in: path
- name: id
+ name: batchId
required: true
schema:
- description: Unique identifier for an unlinked PA template type
type: string
style: simple
+ requestBody:
+ $ref: '#/components/requestBodies/inline_object'
+ content:
+ multipart/form-data:
+ encoding:
+ file:
+ style: form
+ schema:
+ properties:
+ file:
+ format: binary
+ nullable: true
+ type: string
+ type: object
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/UnlinkedPATemplateCategoryAndTypeDetailsRoot'
- description: Expected response, details of the unlinked PA template type
+ $ref: '#/components/schemas/VaultAttributionLoaderResponseRoot'
+ description: Expected response, returns a status of operation along with
+ errors and warnings if found any.
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -36906,49 +34463,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ClientErrorResponse'
- description: Invalid data provided. Please check the request parameters
- before attempting again.
- headers:
- X-DataDirect-Request-Key:
- description: FactSet's request key header.
- explode: false
- schema:
- description: FactSet's request key header.
- type: string
- style: simple
- X-FactSet-Api-Request-Key:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- explode: false
- schema:
- description: Key to uniquely identify an Analytics API request. Only
- available after successful authentication.
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Limit:
- description: Number of allowed requests for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Remaining:
- description: Number of requests left for the time window.
- explode: false
- schema:
- type: string
- style: simple
- X-FactSet-Api-RateLimit-Reset:
- description: Number of seconds remaining till rate limit resets.
- explode: false
- schema:
- type: string
- style: simple
- "404":
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientErrorResponse'
- description: Unlinked PA template type not found.
+ description: Bad Request
headers:
X-DataDirect-Request-Key:
description: FactSet's request key header.
@@ -37143,13 +34658,14 @@ paths:
available after successful authentication.
type: string
style: simple
- summary: Get unlinked PA template type details by id.
+ summary: Vault - External Attribution Loader
tags:
- - UnlinkedPATemplates
+ - Vault Attribution Loader
x-are-multiple-success-responses-different: false
x-success-response-types:
- status-code: "200"
- response-type: UnlinkedPATemplateCategoryAndTypeDetailsRoot
+ response-type: VaultAttributionLoaderResponseRoot
+ x-contentType: multipart/form-data
x-accepts: application/json
/analytics/engines/vault/v3/calculations:
get:
@@ -39558,53 +37074,52 @@ paths:
response-type: ObjectRoot
x-accepts: application/json
components:
+ requestBodies:
+ inline_object:
+ content:
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/inline_object'
schemas:
- ReturnType:
- additionalProperties: false
- example:
- name: name
- id: id
- properties:
- name:
- type: string
- id:
- type: string
- type: object
- SPARAccounts:
- additionalProperties: false
+ AccountDirectories:
example:
- returnsType:
- - name: name
- id: id
- - name: name
- id: id
+ directories:
+ - directories
+ - directories
+ accounts:
+ - accounts
+ - accounts
properties:
- returnsType:
- description: List of SPAR returnsType
+ accounts:
+ description: List of account and composite files.
items:
- $ref: '#/components/schemas/ReturnType'
+ type: string
+ type: array
+ directories:
+ description: List of directories.
+ items:
+ type: string
type: array
type: object
- SPARAccountsRoot:
- additionalProperties: false
+ AccountDirectoriesRoot:
example:
data:
- returnsType:
- - name: name
- id: id
- - name: name
- id: id
+ directories:
+ - directories
+ - directories
+ accounts:
+ - accounts
+ - accounts
meta: '{}'
properties:
data:
- $ref: '#/components/schemas/SPARAccounts'
+ $ref: '#/components/schemas/AccountDirectories'
meta:
type: object
required:
- data
type: object
ErrorSource:
- additionalProperties: false
example:
pointer: pointer
parameter: parameter
@@ -39615,7 +37130,6 @@ components:
type: string
type: object
Error:
- additionalProperties: false
example:
id: id
detail: detail
@@ -39631,55 +37145,13 @@ components:
$ref: '#/components/schemas/ErrorSource'
type: object
ClientErrorResponse:
- additionalProperties: false
properties:
errors:
items:
$ref: '#/components/schemas/Error'
type: array
type: object
- AccountDirectories:
- additionalProperties: false
- example:
- directories:
- - directories
- - directories
- accounts:
- - accounts
- - accounts
- properties:
- accounts:
- description: List of account and composite files.
- items:
- type: string
- type: array
- directories:
- description: List of directories.
- items:
- type: string
- type: array
- type: object
- AccountDirectoriesRoot:
- additionalProperties: false
- example:
- data:
- directories:
- - directories
- - directories
- accounts:
- - accounts
- - accounts
- meta: '{}'
- properties:
- data:
- $ref: '#/components/schemas/AccountDirectories'
- meta:
- type: object
- required:
- - data
- type: object
AFIOptimizerStrategyOverrides:
- additionalProperties: false
example:
alpha: alpha
tax: tax
@@ -39710,7 +37182,6 @@ components:
type: string
type: object
AFIOptimizerStrategy:
- additionalProperties: false
example:
overrides:
alpha: alpha
@@ -39730,7 +37201,6 @@ components:
- id
type: object
OptimizerAccountOverrides:
- additionalProperties: false
example:
portfolio: portfolio
riskModelId: riskModelId
@@ -39751,7 +37221,6 @@ components:
type: string
type: object
OptimizerAccount:
- additionalProperties: false
example:
id: id
overrides:
@@ -39767,7 +37236,6 @@ components:
$ref: '#/components/schemas/OptimizerAccountOverrides'
type: object
Optimization:
- additionalProperties: false
example:
cashflow: cashflow
riskModelDate: riskModelDate
@@ -39784,7 +37252,6 @@ components:
type: string
type: object
OptimizerTradesList:
- additionalProperties: false
example:
includeCash: true
identifierType: Asset
@@ -39808,7 +37275,6 @@ components:
type: boolean
type: object
OptimizerOptimalHoldings:
- additionalProperties: false
example:
includeCash: true
excludeZero: true
@@ -39836,7 +37302,6 @@ components:
type: boolean
type: object
OptimalPortfolio:
- additionalProperties: false
example:
ifOfdbDateExists: abort
excludeZero: true
@@ -39869,10 +37334,8 @@ components:
type: string
type: object
OptimizerStats:
- additionalProperties: false
type: object
OptimizerOutputTypes:
- additionalProperties: false
example:
optimal:
includeCash: true
@@ -39896,11 +37359,9 @@ components:
account:
$ref: '#/components/schemas/OptimalPortfolio'
stats:
- additionalProperties: false
type: object
type: object
AFIOptimizationParameters:
- additionalProperties: false
example:
optimization:
cashflow: cashflow
@@ -39951,10 +37412,8 @@ components:
- strategy
type: object
OptimizerCalculationMeta:
- additionalProperties: false
type: object
AFIOptimizationParametersRoot:
- additionalProperties: false
example:
data:
optimization:
@@ -39997,18 +37456,15 @@ components:
data:
$ref: '#/components/schemas/AFIOptimizationParameters'
meta:
- additionalProperties: false
type: object
type: object
CalculationInfo:
- additionalProperties: false
properties:
calculationId:
description: Calculation identifier
type: string
type: object
CalculationInfoRoot:
- additionalProperties: false
properties:
data:
$ref: '#/components/schemas/CalculationInfo'
@@ -40018,7 +37474,6 @@ components:
- data
type: object
ObjectRoot:
- additionalProperties: false
example:
data: '{}'
meta: '{}'
@@ -40031,7 +37486,6 @@ components:
- data
type: object
AxiomaEquityOptimizerStrategyOverrides:
- additionalProperties: false
example:
alpha: alpha
tax: tax
@@ -40062,7 +37516,6 @@ components:
type: string
type: object
AxiomaEquityOptimizerStrategy:
- additionalProperties: false
example:
overrides:
alpha: alpha
@@ -40082,7 +37535,6 @@ components:
- id
type: object
AxiomaEquityOptimizationParameters:
- additionalProperties: false
example:
optimization:
cashflow: cashflow
@@ -40133,7 +37585,6 @@ components:
- strategy
type: object
AxiomaEquityOptimizationParametersRoot:
- additionalProperties: false
example:
data:
optimization:
@@ -40176,78 +37627,9 @@ components:
data:
$ref: '#/components/schemas/AxiomaEquityOptimizationParameters'
meta:
- additionalProperties: false
type: object
type: object
- SPARIdentifier:
- additionalProperties: false
- description: The account/benchmark parameter for SPAR calculation.
- example:
- prefix: prefix
- returntype: returntype
- id: id
- properties:
- id:
- description: User's FactSet account OR benchmark id.
- type: string
- returntype:
- description: Benchmark return type.
- type: string
- prefix:
- description: Benchmark prefix.
- type: string
- required:
- - id
- type: object
- SPARBenchmark:
- additionalProperties: false
- example:
- identifiers:
- - prefix: prefix
- returntype: returntype
- id: id
- - prefix: prefix
- returntype: returntype
- id: id
- name: name
- id: id
- properties:
- id:
- description: Benchmark identifier
- type: string
- name:
- description: Benchmark Name
- type: string
- identifiers:
- description: List of SPAR identifiers
- items:
- $ref: '#/components/schemas/SPARIdentifier'
- type: array
- type: object
- SPARBenchmarkRoot:
- additionalProperties: false
- example:
- data:
- identifiers:
- - prefix: prefix
- returntype: returntype
- id: id
- - prefix: prefix
- returntype: returntype
- id: id
- name: name
- id: id
- meta: '{}'
- properties:
- data:
- $ref: '#/components/schemas/SPARBenchmark'
- meta:
- type: object
- required:
- - data
- type: object
ConstraintAction:
- additionalProperties: false
example:
item2: Disable
item1: item1
@@ -40261,7 +37643,6 @@ components:
type: string
type: object
BPMOptimizerStrategyAlphaOverride:
- additionalProperties: false
example:
returnMultiplier: returnMultiplier
formula: formula
@@ -40281,7 +37662,6 @@ components:
type: string
type: object
BPMOptimizerStrategyOverrides:
- additionalProperties: false
example:
alpha:
returnMultiplier: returnMultiplier
@@ -40310,7 +37690,6 @@ components:
type: string
type: object
BPMOptimizerStrategy:
- additionalProperties: false
example:
overrides:
alpha:
@@ -40335,7 +37714,6 @@ components:
- id
type: object
BPMOptimization:
- additionalProperties: false
example:
market: market
investAllCash: true
@@ -40360,7 +37738,6 @@ components:
type: string
type: object
BPMOptimizationParameters:
- additionalProperties: false
example:
optimization:
market: market
@@ -40418,7 +37795,6 @@ components:
- strategy
type: object
BPMOptimizationParametersRoot:
- additionalProperties: false
example:
data:
optimization:
@@ -40468,11 +37844,9 @@ components:
data:
$ref: '#/components/schemas/BPMOptimizationParameters'
meta:
- additionalProperties: false
type: object
type: object
ColumnSummary:
- additionalProperties: false
description: Column settings (name, directory, category)
example:
name: name
@@ -40490,7 +37864,6 @@ components:
type: string
type: object
ColumnSummaryRoot:
- additionalProperties: false
example:
data:
key:
@@ -40509,7 +37882,6 @@ components:
- data
type: object
Column:
- additionalProperties: false
example:
defaultstatisticsids:
- defaultstatisticsids
@@ -40534,7 +37906,6 @@ components:
type: string
type: object
ColumnRoot:
- additionalProperties: false
example:
data:
defaultstatisticsids:
@@ -40553,7 +37924,6 @@ components:
- data
type: object
ColumnStatistic:
- additionalProperties: false
example:
name: name
properties:
@@ -40562,7 +37932,6 @@ components:
type: string
type: object
ColumnStatisticRoot:
- additionalProperties: false
example:
data:
key:
@@ -40579,7 +37948,6 @@ components:
- data
type: object
ComponentSummary:
- additionalProperties: false
example:
name: name
category: category
@@ -40592,7 +37960,6 @@ components:
type: string
type: object
ComponentSummaryRoot:
- additionalProperties: false
example:
data:
key:
@@ -40610,7 +37977,6 @@ components:
- data
type: object
PAIdentifier:
- additionalProperties: false
example:
id: id
holdingsmode: holdingsmode
@@ -40625,7 +37991,6 @@ components:
- id
type: object
PADateParameters:
- additionalProperties: false
description: The date parameters for PA calculation.
example:
enddate: enddate
@@ -40646,7 +38011,6 @@ components:
- frequency
type: object
PAComponent:
- additionalProperties: false
example:
currencyisocode: currencyisocode
path: path
@@ -40700,7 +38064,6 @@ components:
type: string
type: object
PAComponentRoot:
- additionalProperties: false
example:
data:
currencyisocode: currencyisocode
@@ -40733,7 +38096,6 @@ components:
- data
type: object
VaultIdentifier:
- additionalProperties: false
description: The account/benchmark parameter for Vault calculation.
example:
id: id
@@ -40745,7 +38107,6 @@ components:
- id
type: object
VaultDateParameters:
- additionalProperties: false
description: The date parameters for Vault calculation
example:
enddate: enddate
@@ -40766,7 +38127,6 @@ components:
- frequency
type: object
VaultComponent:
- additionalProperties: false
example:
currencyisocode: currencyisocode
path: path
@@ -40809,7 +38169,6 @@ components:
type: string
type: object
VaultComponentRoot:
- additionalProperties: false
example:
data:
currencyisocode: currencyisocode
@@ -40836,7 +38195,6 @@ components:
- data
type: object
VaultConfigurationSummary:
- additionalProperties: false
example:
name: name
properties:
@@ -40845,7 +38203,6 @@ components:
type: string
type: object
VaultConfigurationSummaryRoot:
- additionalProperties: false
example:
data:
key:
@@ -40862,7 +38219,6 @@ components:
- data
type: object
ConfigurationAccount:
- additionalProperties: false
example:
maxEndDate: maxEndDate
minStartDate: minStartDate
@@ -40891,7 +38247,6 @@ components:
type: string
type: object
VaultConfiguration:
- additionalProperties: false
example:
name: name
accounts:
@@ -40912,7 +38267,6 @@ components:
type: object
type: object
VaultConfigurationRoot:
- additionalProperties: false
example:
data:
name: name
@@ -40934,7 +38288,6 @@ components:
- data
type: object
Currency:
- additionalProperties: false
example:
name: name
properties:
@@ -40943,7 +38296,6 @@ components:
type: string
type: object
CurrencyRoot:
- additionalProperties: false
example:
data:
key:
@@ -40960,7 +38312,6 @@ components:
- data
type: object
DateParametersSummary:
- additionalProperties: false
example:
enddate: enddate
startdate: startdate
@@ -40973,7 +38324,6 @@ components:
type: string
type: object
DateParametersSummaryRoot:
- additionalProperties: false
example:
data:
enddate: enddate
@@ -40988,7 +38338,6 @@ components:
- data
type: object
FIDiscountCurveInfo:
- additionalProperties: false
example:
name: name
currency: currency
@@ -41002,7 +38351,6 @@ components:
type: string
type: object
FIDiscountCurveInfoRoot:
- additionalProperties: false
example:
data:
key:
@@ -41021,7 +38369,6 @@ components:
- data
type: object
DocumentDirectories:
- additionalProperties: false
example:
documents:
- documents
@@ -41042,7 +38389,6 @@ components:
type: array
type: object
DocumentDirectoriesRoot:
- additionalProperties: false
example:
data:
documents:
@@ -41061,7 +38407,6 @@ components:
- data
type: object
FIABIdentifier:
- additionalProperties: false
example:
id: id
properties:
@@ -41072,7 +38417,6 @@ components:
- id
type: object
FIABDateParameters:
- additionalProperties: false
description: The date parameters for FIAB calculations.
example:
enddate: enddate
@@ -41089,7 +38433,6 @@ components:
- startdate
type: object
FIABCalculationParameters:
- additionalProperties: false
example:
fiabdocument: fiabdocument
msl: msl
@@ -41122,7 +38465,6 @@ components:
- dates
type: object
FIABCalculationStatusSummary:
- additionalProperties: false
properties:
requesttime:
description: Request time of calculation.
@@ -41134,7 +38476,6 @@ components:
type: string
type: object
EventSummary:
- additionalProperties: false
example:
submissiondatetime: 2000-01-23T04:56:07.000+00:00
message: message
@@ -41152,7 +38493,6 @@ components:
type: string
type: object
FIABCalculationStatus:
- additionalProperties: false
example:
completiondatetime: 2000-01-23T04:56:07.000+00:00
batchevents:
@@ -41199,7 +38539,6 @@ components:
type: array
type: object
FIReferencePrepay:
- additionalProperties: false
example:
prepayName: prepayName
properties:
@@ -41208,7 +38547,6 @@ components:
type: string
type: object
FIReferenceSecurity:
- additionalProperties: false
example:
calcFromMethod: calcFromMethod
prepay:
@@ -41242,7 +38580,6 @@ components:
type: string
type: object
FIBankLoans:
- additionalProperties: false
example:
ignoreSinkingFund: true
properties:
@@ -41251,7 +38588,6 @@ components:
type: boolean
type: object
FIMunicipalBonds:
- additionalProperties: false
example:
useAnticipatedSinkSchedule: true
ignoreSinkingFund: true
@@ -41264,7 +38600,6 @@ components:
type: boolean
type: object
FILoss:
- additionalProperties: false
example:
lossName: lossName
properties:
@@ -41273,7 +38608,6 @@ components:
type: string
type: object
FIPrepay:
- additionalProperties: false
example:
prepayName: prepayName
properties:
@@ -41282,7 +38616,6 @@ components:
type: string
type: object
FIServicerAdvancesForSecurities:
- additionalProperties: false
example:
principal: 5.962133916683182
interest: 5.637376656633329
@@ -41307,7 +38640,6 @@ components:
type: string
type: object
FIPrepayLockout:
- additionalProperties: false
example:
pointsAbove: ANY
ymAbove: ANY
@@ -41328,7 +38660,6 @@ components:
type: string
type: object
FICashflows:
- additionalProperties: false
example:
optionalRedemptionCallWhenUnits: Manual
optionalRedemptionCallWhen: 2
@@ -41354,7 +38685,6 @@ components:
type: integer
type: object
FIBalloonExtension:
- additionalProperties: false
example:
months: 9
percentage: 3.616076749251911
@@ -41386,7 +38716,6 @@ components:
type: number
type: object
FIStructuredProductsForSecurities:
- additionalProperties: false
example:
balloonExtension:
months: 9
@@ -41428,7 +38757,6 @@ components:
$ref: '#/components/schemas/FIBalloonExtension'
type: object
FISecurity:
- additionalProperties: false
example:
callMethod: No Call
symbol: symbol
@@ -41544,7 +38872,6 @@ components:
- symbol
type: object
FIMunicipalBondsForJobSettings:
- additionalProperties: false
example:
useAnticipatedSinkSchedule: true
ignoreSinkingFund: true
@@ -41561,7 +38888,6 @@ components:
type: boolean
type: object
FIMarketEnvironment:
- additionalProperties: false
example:
ratePath: FLAT & FORWARD
properties:
@@ -41575,7 +38901,6 @@ components:
type: string
type: object
FIServicerAdvances:
- additionalProperties: false
example:
advanceType: Advances All
properties:
@@ -41590,7 +38915,6 @@ components:
type: string
type: object
FIStructuredProductsForJobSettings:
- additionalProperties: false
example:
balloonExtension:
months: 9
@@ -41630,7 +38954,6 @@ components:
$ref: '#/components/schemas/FIBalloonExtension'
type: object
FIJobSettings:
- additionalProperties: false
example:
callMethod: No Call
calcFromMethod: calcFromMethod
@@ -41706,7 +39029,6 @@ components:
- asOfDate
type: object
FICalculationParameters:
- additionalProperties: false
example:
jobSettings:
callMethod: No Call
@@ -41862,7 +39184,6 @@ components:
- securities
type: object
CalculationMeta:
- additionalProperties: false
example:
contentorganization: SimplifiedRow
format: JsonStach
@@ -41908,7 +39229,6 @@ components:
type: string
type: object
FICalculationParametersRoot:
- additionalProperties: false
example:
data:
jobSettings:
@@ -42058,7 +39378,6 @@ components:
$ref: '#/components/schemas/CalculationMeta'
type: object
PaDoc:
- additionalProperties: false
example:
id: id
properties:
@@ -42069,7 +39388,6 @@ components:
- id
type: object
FPOAccount:
- additionalProperties: false
example:
paDocument:
id: id
@@ -42091,7 +39409,6 @@ components:
- paDocument
type: object
FPOObjective:
- additionalProperties: false
example:
terms:
key: Disable
@@ -42108,7 +39425,6 @@ components:
type: object
type: object
FPOOptimizerStrategyOverrides:
- additionalProperties: false
example:
alpha: alpha
transactionCost: transactionCost
@@ -42137,7 +39453,6 @@ components:
type: string
type: object
FPOOptimizerStrategy:
- additionalProperties: false
example:
overrides:
alpha: alpha
@@ -42159,7 +39474,6 @@ components:
- id
type: object
FPOOptimizationParameters:
- additionalProperties: false
example:
optimization:
cashflow: cashflow
@@ -42214,7 +39528,6 @@ components:
- strategy
type: object
FPOOptimizationParametersRoot:
- additionalProperties: false
example:
data:
optimization:
@@ -42261,11 +39574,9 @@ components:
data:
$ref: '#/components/schemas/FPOOptimizationParameters'
meta:
- additionalProperties: false
type: object
type: object
Frequency:
- additionalProperties: false
example:
name: name
properties:
@@ -42274,7 +39585,6 @@ components:
type: string
type: object
FrequencyRoot:
- additionalProperties: false
example:
data:
key:
@@ -42291,7 +39601,6 @@ components:
- data
type: object
Group:
- additionalProperties: false
example:
name: name
category: category
@@ -42308,7 +39617,6 @@ components:
type: string
type: object
GroupRoot:
- additionalProperties: false
example:
data:
key:
@@ -42327,7 +39635,6 @@ components:
- data
type: object
TemplateContentTypes:
- additionalProperties: false
example:
optional:
- optional
@@ -42356,7 +39663,6 @@ components:
type: array
type: object
LinkedPATemplateParameters:
- additionalProperties: false
example:
parentComponentId: parentComponentId
description: description
@@ -42388,7 +39694,6 @@ components:
- parentComponentId
type: object
LinkedPATemplateParametersRoot:
- additionalProperties: false
example:
data:
parentComponentId: parentComponentId
@@ -42414,7 +39719,6 @@ components:
- data
type: object
LinkedPATemplatePostSummary:
- additionalProperties: false
example:
parentComponentId: parentComponentId
name: name
@@ -42435,7 +39739,6 @@ components:
type: string
type: object
LinkedPATemplatePostSummaryRoot:
- additionalProperties: false
example:
data:
parentComponentId: parentComponentId
@@ -42452,7 +39755,6 @@ components:
- data
type: object
LinkedPATemplateSummary:
- additionalProperties: false
example:
parentComponentId: parentComponentId
name: name
@@ -42469,7 +39771,6 @@ components:
type: string
type: object
LinkedPATemplateSummaryRoot:
- additionalProperties: false
example:
data:
key:
@@ -42488,7 +39789,6 @@ components:
- data
type: object
LinkedPATemplateUpdateParameters:
- additionalProperties: false
example:
parentComponentId: parentComponentId
description: description
@@ -42513,7 +39813,6 @@ components:
$ref: '#/components/schemas/TemplateContentTypes'
type: object
LinkedPATemplateUpdateParametersRoot:
- additionalProperties: false
example:
data:
parentComponentId: parentComponentId
@@ -42538,7 +39837,6 @@ components:
- data
type: object
LinkedPATemplate:
- additionalProperties: false
example:
parentComponentId: parentComponentId
name: name
@@ -42579,7 +39877,6 @@ components:
type: string
type: object
LinkedPATemplateRoot:
- additionalProperties: false
example:
data:
parentComponentId: parentComponentId
@@ -42608,7 +39905,6 @@ components:
- data
type: object
NPOOptimizerStrategyOverrides:
- additionalProperties: false
example:
alpha: alpha
tax: tax
@@ -42642,7 +39938,6 @@ components:
type: string
type: object
NPOOptimizerStrategy:
- additionalProperties: false
example:
overrides:
alpha: alpha
@@ -42666,7 +39961,6 @@ components:
- id
type: object
NPOOptimizationParameters:
- additionalProperties: false
example:
optimization:
cashflow: cashflow
@@ -42721,7 +40015,6 @@ components:
- strategy
type: object
NPOOptimizationParametersRoot:
- additionalProperties: false
example:
data:
optimization:
@@ -42768,11 +40061,9 @@ components:
data:
$ref: '#/components/schemas/NPOOptimizationParameters'
meta:
- additionalProperties: false
type: object
type: object
PACalculationGroup:
- additionalProperties: false
example:
id: id
frequency: frequency
@@ -42785,7 +40076,6 @@ components:
type: string
type: object
PACalculationColumn:
- additionalProperties: false
example:
id: id
statistics:
@@ -42802,7 +40092,6 @@ components:
type: array
type: object
PACalculationPricingSource:
- additionalProperties: false
example:
id: id
properties:
@@ -42811,7 +40100,6 @@ components:
type: string
type: object
PACalculationDataSources:
- additionalProperties: false
example:
benchmarkpricingsources:
- id: id
@@ -42836,7 +40124,6 @@ components:
type: boolean
type: object
PACalculationParameters:
- additionalProperties: false
example:
currencyisocode: currencyisocode
componentdetail: componentdetail
@@ -42918,7 +40205,6 @@ components:
- componentid
type: object
PACalculationParametersRoot:
- additionalProperties: false
example:
data:
key:
@@ -42976,9 +40262,11 @@ components:
$ref: '#/components/schemas/CalculationMeta'
type: object
CalculationUnitStatus:
- additionalProperties: false
example:
result: result
+ warnings:
+ - warnings
+ - warnings
progress: progress
errors:
- id: id
@@ -43018,14 +40306,21 @@ components:
description: The points for the calculation unit.
format: int32
type: integer
+ warnings:
+ description: The warnings in a calculation unit.
+ items:
+ type: string
+ type: array
type: object
CalculationStatus:
- additionalProperties: false
example:
calculationid: calculationid
units:
key:
result: result
+ warnings:
+ - warnings
+ - warnings
progress: progress
errors:
- id: id
@@ -43060,7 +40355,6 @@ components:
type: object
type: object
CalculationUnitStatusMeta:
- additionalProperties: false
example:
info: info
properties:
@@ -43069,7 +40363,6 @@ components:
type: string
type: object
CalculationStatusMeta:
- additionalProperties: false
example:
units:
key:
@@ -43082,13 +40375,15 @@ components:
type: object
type: object
CalculationStatusRoot:
- additionalProperties: false
example:
data:
calculationid: calculationid
units:
key:
result: result
+ warnings:
+ - warnings
+ - warnings
progress: progress
errors:
- id: id
@@ -43117,7 +40412,6 @@ components:
- data
type: object
CalculationsSummary:
- additionalProperties: false
example:
requestTime: 2000-01-23T04:56:07.000+00:00
lastPollTime: 2000-01-23T04:56:07.000+00:00
@@ -43146,7 +40440,6 @@ components:
type: string
type: object
PaginationInfo:
- additionalProperties: false
example:
pageNumber: 6
previousPage: previousPage
@@ -43173,7 +40466,6 @@ components:
type: string
type: object
PaginationMeta:
- additionalProperties: false
example:
pagination:
pageNumber: 6
@@ -43187,7 +40479,6 @@ components:
$ref: '#/components/schemas/PaginationInfo'
type: object
CalculationsSummaryRoot:
- additionalProperties: false
example:
data:
requestTime: 2000-01-23T04:56:07.000+00:00
@@ -43211,7 +40502,6 @@ components:
- data
type: object
PAPricingSource:
- additionalProperties: false
example:
name: name
category: category
@@ -43228,7 +40518,6 @@ components:
type: string
type: object
PAPricingSourceRoot:
- additionalProperties: false
example:
data:
key:
@@ -43247,7 +40536,6 @@ components:
- data
type: object
PubIdentifier:
- additionalProperties: false
example:
id: id
holdingsmode: holdingsmode
@@ -43262,7 +40550,6 @@ components:
- id
type: object
PubDateParameters:
- additionalProperties: false
description: The date parameters for Publisher calculation.
example:
enddate: enddate
@@ -43278,7 +40565,6 @@ components:
- enddate
type: object
PubCalculationParameters:
- additionalProperties: false
example:
document: document
dates:
@@ -43301,10 +40587,8 @@ components:
- document
type: object
PubCalculationMeta:
- additionalProperties: false
type: object
PubCalculationParametersRoot:
- additionalProperties: false
example:
data:
key:
@@ -43323,11 +40607,9 @@ components:
description: List of calculation parameters.
type: object
meta:
- additionalProperties: false
type: object
type: object
QuantScreeningExpressionUniverse:
- additionalProperties: false
allOf:
- $ref: '#/components/schemas/QuantUniverse'
properties:
@@ -43345,7 +40627,6 @@ components:
- universeType
type: object
QuantIdentifierUniverse:
- additionalProperties: false
allOf:
- $ref: '#/components/schemas/QuantUniverse'
properties:
@@ -43363,7 +40644,6 @@ components:
- universeType
type: object
QuantUniverse:
- additionalProperties: false
properties:
source:
enum:
@@ -43375,7 +40655,6 @@ components:
- source
type: object
QuantUniversalScreenUniverse:
- additionalProperties: false
allOf:
- $ref: '#/components/schemas/QuantUniverse'
properties:
@@ -43385,7 +40664,6 @@ components:
- screen
type: object
QuantDateList:
- additionalProperties: false
allOf:
- $ref: '#/components/schemas/QuantDate'
properties:
@@ -43395,7 +40673,6 @@ components:
type: array
type: object
QuantDate:
- additionalProperties: false
properties:
source:
enum:
@@ -43414,7 +40691,6 @@ components:
- source
type: object
QuantFdsDate:
- additionalProperties: false
allOf:
- $ref: '#/components/schemas/QuantDate'
properties:
@@ -43427,7 +40703,6 @@ components:
- startDate
type: object
QuantFqlExpression:
- additionalProperties: false
allOf:
- $ref: '#/components/schemas/QuantFormula'
properties:
@@ -43444,7 +40719,6 @@ components:
- name
type: object
QuantUniversalScreenParameter:
- additionalProperties: false
allOf:
- $ref: '#/components/schemas/QuantFormula'
properties:
@@ -43457,12 +40731,10 @@ components:
- referenceName
type: object
QuantAllUniversalScreenParameters:
- additionalProperties: false
allOf:
- $ref: '#/components/schemas/QuantFormula'
type: object
QuantFormula:
- additionalProperties: false
properties:
source:
enum:
@@ -43475,7 +40747,6 @@ components:
- source
type: object
QuantScreeningExpression:
- additionalProperties: false
allOf:
- $ref: '#/components/schemas/QuantFormula'
properties:
@@ -43490,7 +40761,6 @@ components:
- name
type: object
QuantScreeningExpressionUniverseObsolete:
- additionalProperties: false
properties:
universeExpr:
type: string
@@ -43512,7 +40782,6 @@ components:
- universeType
type: object
QuantUniversalScreenUniverseObsolete:
- additionalProperties: false
properties:
screen:
type: string
@@ -43526,7 +40795,6 @@ components:
- screen
type: object
QuantIdentifierUniverseObsolete:
- additionalProperties: false
properties:
universeType:
enum:
@@ -43548,7 +40816,6 @@ components:
- universeType
type: object
QuantFdsDateObsolete:
- additionalProperties: false
properties:
startDate:
type: string
@@ -43567,7 +40834,6 @@ components:
- startDate
type: object
QuantDateListObsolete:
- additionalProperties: false
properties:
dates:
items:
@@ -43584,7 +40850,6 @@ components:
- frequency
type: object
QuantScreeningExpressionObsolete:
- additionalProperties: false
properties:
expr:
type: string
@@ -43597,7 +40862,6 @@ components:
- name
type: object
QuantFqlExpressionObsolete:
- additionalProperties: false
properties:
expr:
type: string
@@ -43612,7 +40876,6 @@ components:
- name
type: object
QuantUniversalScreenParameterObsolete:
- additionalProperties: false
properties:
referenceName:
type: string
@@ -43623,7 +40886,6 @@ components:
- referenceName
type: object
QuantAllUniversalScreenParametersObsolete:
- additionalProperties: false
type: object
OneOfQuantUniverse:
discriminator:
@@ -43663,7 +40925,6 @@ components:
$ref: '#/components/schemas/OneOfQuantFormulas'
type: array
QuantCalculationParameters:
- additionalProperties: false
example:
formulas:
- null
@@ -43682,7 +40943,6 @@ components:
type: string
type: object
QuantCalculationMeta:
- additionalProperties: false
example:
contentorganization: SimplifiedRow
allowArrayData: true
@@ -43731,7 +40991,6 @@ components:
type: string
type: object
QuantCalculationParametersRoot:
- additionalProperties: false
example:
data:
key:
@@ -43754,105 +41013,816 @@ components:
meta:
$ref: '#/components/schemas/QuantCalculationMeta'
type: object
- SPARDateParameters:
- additionalProperties: false
- description: The date parameters for SPAR calculation.
+ SMRetrieveParameters:
example:
- enddate: enddate
- startdate: startdate
- frequency: frequency
+ securityName: securityName
+ asofdate: asofdate
+ securityType: Bond
+ location: location
properties:
- startdate:
- description: Calculation's start date.
+ securityName:
type: string
- enddate:
- description: Calculation's end date.
+ location:
type: string
- frequency:
- description: Calculation's frequency.
+ asofdate:
+ type: string
+ securityType:
+ enum:
+ - Bond
+ - CCF
type: string
required:
- - enddate
- - frequency
- - startdate
+ - securityName
type: object
- SPARCalculationParameters:
- additionalProperties: false
+ SMRetrieveParametersRoot:
example:
- currencyisocode: currencyisocode
- componentid: componentid
- dates:
- enddate: enddate
- startdate: startdate
- frequency: frequency
- accounts:
- - prefix: prefix
- returntype: returntype
- id: id
- - prefix: prefix
- returntype: returntype
- id: id
- benchmark:
- prefix: prefix
- returntype: returntype
- id: id
+ data:
+ - securityName: securityName
+ asofdate: asofdate
+ securityType: Bond
+ location: location
+ - securityName: securityName
+ asofdate: asofdate
+ securityType: Bond
+ location: location
+ meta: '{}'
properties:
- componentid:
- description: The SPAR Engine component identifier to analyze.
+ data:
+ items:
+ $ref: '#/components/schemas/SMRetrieveParameters'
+ type: array
+ meta:
+ type: object
+ required:
+ - data
+ type: object
+ SMCustomCashFlowFields:
+ allOf:
+ - $ref: '#/components/schemas/SMFields'
+ properties:
+ cashFlowAmounts:
+ items:
+ format: double
+ type: number
+ type: array
+ cashFlowDates:
+ items:
+ type: string
+ type: array
+ country:
type: string
- accounts:
- description: List of accounts for SPAR calculation.
+ currency:
+ type: string
+ issueName:
+ type: string
+ parAmt:
+ format: double
+ type: number
+ parentName:
+ type: string
+ ratingFitch:
+ type: string
+ ratingFitchDates:
items:
- $ref: '#/components/schemas/SPARIdentifier'
+ type: string
type: array
- benchmark:
- $ref: '#/components/schemas/SPARIdentifier'
- dates:
- $ref: '#/components/schemas/SPARDateParameters'
- currencyisocode:
- description: Currency ISO code for calculation.
+ ratingFitchValues:
+ items:
+ type: string
+ type: array
+ ratingMoodysDates:
+ items:
+ type: string
+ type: array
+ ratingMoodysValues:
+ items:
+ type: string
+ type: array
+ ratingSpDates:
+ items:
+ type: string
+ type: array
+ ratingSpValues:
+ items:
+ type: string
+ type: array
+ secondaryToVendorFlag:
+ type: boolean
+ sector:
+ type: string
+ sectorBarclay1:
+ type: string
+ sectorBarclay2:
+ type: string
+ sectorBarclay3:
+ type: string
+ sectorBarclay4:
+ type: string
+ sectorDef:
+ type: string
+ sectorIndustry:
+ type: string
+ sectorMain:
+ type: string
+ sectorMerrill1:
+ type: string
+ sectorMerrill2:
+ type: string
+ sectorMerrill3:
+ type: string
+ sectorMerrill4:
+ type: string
+ sectorSubGroup:
+ type: string
+ vendorCoverageDate:
+ type: string
+ type: object
+ SMFields:
+ properties:
+ securityType:
+ enum:
+ - Bond
+ - CCF
type: string
required:
- - componentid
+ - securityType
type: object
- SPARCalculationParametersRoot:
- additionalProperties: false
+ SMBondFields:
+ allOf:
+ - $ref: '#/components/schemas/SMFields'
+ properties:
+ "144aFlag":
+ type: boolean
+ aperiodicMultipliers:
+ items:
+ format: double
+ type: number
+ type: array
+ aperiodicResetDates:
+ items:
+ type: string
+ type: array
+ aperiodicSpreads:
+ items:
+ format: double
+ type: number
+ type: array
+ businessDayConv:
+ type: string
+ callAnnouncedDate:
+ type: string
+ callDates:
+ items:
+ type: string
+ type: array
+ callFreq:
+ type: string
+ callNoticeDays:
+ format: int32
+ type: integer
+ callPrices:
+ items:
+ format: double
+ type: number
+ type: array
+ cashRate:
+ format: double
+ type: number
+ cognity:
+ type: string
+ conversionIdentifier:
+ type: string
+ conversionRatio:
+ format: double
+ type: number
+ conversionType:
+ type: string
+ convertibleFlag:
+ type: boolean
+ country:
+ type: string
+ coupon:
+ format: double
+ type: number
+ couponType:
+ type: string
+ creditSpreadAdjustmentSingle:
+ format: double
+ type: number
+ currency:
+ type: string
+ dayCountBasis:
+ type: string
+ defaultedDate:
+ type: string
+ federalTaxExemptFlag:
+ type: boolean
+ firstPayDate:
+ type: string
+ firstResetDate:
+ type: string
+ floatFormula:
+ type: string
+ fltDayCountBasis:
+ type: string
+ fltFirstPayDate:
+ type: string
+ fltPayFreq:
+ type: string
+ histCouponDates:
+ items:
+ type: string
+ type: array
+ histCoupons:
+ items:
+ format: double
+ type: number
+ type: array
+ histRcvAssumpDates:
+ items:
+ type: string
+ type: array
+ histRcvAssumpMonths:
+ items:
+ format: int32
+ type: integer
+ type: array
+ histRcvAssumpRates:
+ items:
+ format: double
+ type: number
+ type: array
+ histRcvAssumpTargetDates:
+ items:
+ type: string
+ type: array
+ inflationType:
+ type: string
+ issueDate:
+ type: string
+ issueName:
+ type: string
+ issuerId:
+ type: string
+ lastModifiedSource:
+ type: string
+ lastModifiedSourceMeta:
+ type: string
+ lastModifiedTime:
+ type: string
+ lifeCap:
+ format: double
+ type: number
+ lifeFloor:
+ format: double
+ type: number
+ lockoutDays:
+ format: int32
+ type: integer
+ lookBackDays:
+ format: int32
+ type: integer
+ makeWholeCallFlag:
+ type: boolean
+ makeWholeExpireDate:
+ type: string
+ makeWholeSpread:
+ format: double
+ type: number
+ matrixDates:
+ items:
+ type: string
+ type: array
+ matrixMultipliers:
+ items:
+ format: double
+ type: number
+ type: array
+ matrixPricedFlag:
+ type: boolean
+ matrixSpreads:
+ items:
+ format: double
+ type: number
+ type: array
+ matrixUseScheduleFlag:
+ type: boolean
+ maturityDate:
+ type: string
+ maturityPrice:
+ format: double
+ type: number
+ monthsToRecovery:
+ format: double
+ type: number
+ multiplier:
+ format: double
+ type: number
+ notionalFlag:
+ type: boolean
+ observationShift:
+ format: int32
+ type: integer
+ origAmtIssued:
+ format: double
+ type: number
+ parentName:
+ type: string
+ parPrice:
+ format: double
+ type: number
+ parserInfo:
+ type: string
+ paymentDelay:
+ format: int32
+ type: integer
+ payFreq:
+ type: string
+ periodCap:
+ format: double
+ type: number
+ periodFloor:
+ format: double
+ type: number
+ pikExpDate:
+ type: string
+ pikRate:
+ format: int32
+ type: integer
+ preferredSecExDateLen:
+ format: int32
+ type: integer
+ preferredSecExDateUnits:
+ type: string
+ preferredSecFlag:
+ type: boolean
+ preferredSecType:
+ type: string
+ principalType:
+ type: string
+ putDates:
+ items:
+ type: string
+ type: array
+ putNoticeDays:
+ format: int32
+ type: integer
+ putFreq:
+ type: string
+ putPrices:
+ items:
+ format: double
+ type: number
+ type: array
+ pvtPlacementFlag:
+ type: boolean
+ ratingFitch:
+ type: string
+ ratingFitchDates:
+ items:
+ type: string
+ type: array
+ ratingFitchValues:
+ items:
+ type: string
+ type: array
+ ratingMoodysDates:
+ items:
+ type: string
+ type: array
+ ratingMoodysValues:
+ items:
+ type: string
+ type: array
+ ratingSpDates:
+ items:
+ type: string
+ type: array
+ ratingSpValues:
+ items:
+ type: string
+ type: array
+ recoveryPercentage:
+ format: double
+ type: number
+ redemptionDate:
+ type: string
+ redemptionOpt:
+ type: string
+ redemptionPrice:
+ format: double
+ type: number
+ reinstatedDate:
+ type: string
+ resetDelay:
+ format: int32
+ type: integer
+ resetFreq:
+ type: string
+ refIndex:
+ type: string
+ secondaryToVendorFlag:
+ type: boolean
+ sector:
+ type: string
+ sectorBarclay1:
+ type: string
+ sectorBarclay2:
+ type: string
+ sectorBarclay3:
+ type: string
+ sectorBarclay4:
+ type: string
+ sectorDef:
+ type: string
+ sectorIndustry:
+ type: string
+ sectorMain:
+ type: string
+ sectorMerrill1:
+ type: string
+ sectorMerrill2:
+ type: string
+ sectorMerrill3:
+ type: string
+ sectorMerrill4:
+ type: string
+ sectorSubGroup:
+ type: string
+ sinkAmts:
+ items:
+ format: double
+ type: number
+ type: array
+ sinkDates:
+ items:
+ type: string
+ type: array
+ spread:
+ format: double
+ type: number
+ state:
+ type: string
+ status:
+ type: string
+ statusDates:
+ items:
+ type: string
+ type: array
+ statusValues:
+ items:
+ type: string
+ type: array
+ stepCashRates:
+ items:
+ format: double
+ type: number
+ type: array
+ stepCouponDates:
+ items:
+ type: string
+ type: array
+ stepCoupons:
+ items:
+ format: double
+ type: number
+ type: array
+ stepPikRates:
+ items:
+ format: double
+ type: number
+ type: array
+ vendorCoverageDate:
+ type: string
+ vRDNFlag:
+ type: boolean
+ type: object
+ SMError:
+ example:
+ detail: detail
+ properties:
+ detail:
+ type: string
+ type: object
+ OneOfFieldsFields:
+ discriminator:
+ mapping:
+ Bond: '#/components/schemas/SMBondFields'
+ CCF: '#/components/schemas/SMCustomCashFlowFields'
+ propertyName: securityType
+ oneOf:
+ - $ref: '#/components/schemas/SMBondFields'
+ - $ref: '#/components/schemas/SMCustomCashFlowFields'
+ SMRetrieveResponse:
+ example:
+ securityName: securityName
+ asofdate: asofdate
+ location: location
+ errors:
+ - detail: detail
+ - detail: detail
+ status: success
+ properties:
+ securityName:
+ type: string
+ status:
+ enum:
+ - success
+ - failure
+ type: string
+ location:
+ type: string
+ asofdate:
+ type: string
+ fields:
+ $ref: '#/components/schemas/OneOfFieldsFields'
+ errors:
+ items:
+ $ref: '#/components/schemas/SMError'
+ type: array
+ type: object
+ SMRetrieveResponseRoot:
example:
data:
- key:
- currencyisocode: currencyisocode
- componentid: componentid
- dates:
- enddate: enddate
- startdate: startdate
- frequency: frequency
- accounts:
- - prefix: prefix
- returntype: returntype
- id: id
- - prefix: prefix
- returntype: returntype
- id: id
- benchmark:
- prefix: prefix
- returntype: returntype
- id: id
+ - securityName: securityName
+ asofdate: asofdate
+ location: location
+ errors:
+ - detail: detail
+ - detail: detail
+ status: success
+ - securityName: securityName
+ asofdate: asofdate
+ location: location
+ errors:
+ - detail: detail
+ - detail: detail
+ status: success
+ meta: '{}'
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/SMRetrieveResponse'
+ type: array
meta:
- contentorganization: SimplifiedRow
- format: JsonStach
- stachContentOrganization: SimplifiedRow
- contenttype: Json
+ type: object
+ required:
+ - data
+ type: object
+ OneOfSMFields:
+ discriminator:
+ mapping:
+ Bond: '#/components/schemas/SMBondFields'
+ CCF: '#/components/schemas/SMCustomCashFlowFields'
+ propertyName: securityType
+ oneOf:
+ - $ref: '#/components/schemas/SMBondFields'
+ - $ref: '#/components/schemas/SMCustomCashFlowFields'
+ SMCreateParameters:
+ example:
+ securityName: securityName
+ asofdate: asofdate
+ location: location
+ properties:
+ securityName:
+ type: string
+ location:
+ type: string
+ asofdate:
+ type: string
+ fields:
+ $ref: '#/components/schemas/OneOfSMFields'
+ required:
+ - fields
+ - securityName
+ type: object
+ SMCreateParametersRoot:
+ example:
+ data:
+ - securityName: securityName
+ asofdate: asofdate
+ location: location
+ - securityName: securityName
+ asofdate: asofdate
+ location: location
+ meta: '{}'
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/SMCreateParameters'
+ type: array
+ meta:
+ type: object
+ required:
+ - data
+ type: object
+ SMWarning:
+ example:
+ detail: detail
+ properties:
+ detail:
+ type: string
+ type: object
+ SMCreateResponse:
+ example:
+ securityName: securityName
+ warnings:
+ - detail: detail
+ - detail: detail
+ errors:
+ - detail: detail
+ - detail: detail
+ status: success
+ properties:
+ securityName:
+ type: string
+ status:
+ enum:
+ - success
+ - failure
+ type: string
+ warnings:
+ items:
+ $ref: '#/components/schemas/SMWarning'
+ type: array
+ errors:
+ items:
+ $ref: '#/components/schemas/SMError'
+ type: array
+ type: object
+ SMCreateResponseRoot:
+ example:
+ data:
+ - securityName: securityName
+ warnings:
+ - detail: detail
+ - detail: detail
+ errors:
+ - detail: detail
+ - detail: detail
+ status: success
+ - securityName: securityName
+ warnings:
+ - detail: detail
+ - detail: detail
+ errors:
+ - detail: detail
+ - detail: detail
+ status: success
+ meta: '{}'
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/SMCreateResponse'
+ type: array
+ meta:
+ type: object
+ required:
+ - data
+ type: object
+ SMDeleteParameters:
+ example:
+ securityName: securityName
+ asofdate: asofdate
+ securityType: Bond
+ location: location
+ properties:
+ securityName:
+ type: string
+ location:
+ type: string
+ asofdate:
+ type: string
+ securityType:
+ enum:
+ - Bond
+ - CCF
+ type: string
+ required:
+ - securityName
+ type: object
+ SMDeleteParametersRoot:
+ example:
+ data:
+ - securityName: securityName
+ asofdate: asofdate
+ securityType: Bond
+ location: location
+ - securityName: securityName
+ asofdate: asofdate
+ securityType: Bond
+ location: location
+ meta: '{}'
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/SMDeleteParameters'
+ type: array
+ meta:
+ type: object
+ required:
+ - data
+ type: object
+ SMDeleteResponse:
+ example:
+ securityName: securityName
+ errors:
+ - detail: detail
+ - detail: detail
+ status: success
+ properties:
+ securityName:
+ type: string
+ status:
+ enum:
+ - success
+ - failure
+ type: string
+ errors:
+ items:
+ $ref: '#/components/schemas/SMError'
+ type: array
+ type: object
+ SMDeleteResponseRoot:
+ example:
+ data:
+ - securityName: securityName
+ errors:
+ - detail: detail
+ - detail: detail
+ status: success
+ - securityName: securityName
+ errors:
+ - detail: detail
+ - detail: detail
+ status: success
+ meta: '{}'
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/SMDeleteResponse'
+ type: array
+ meta:
+ type: object
+ required:
+ - data
+ type: object
+ SMTemplateFieldProperties:
+ example:
+ category:
+ - category
+ - category
+ mandatory: true
+ whenField:
+ - key:
+ - whenField
+ - whenField
+ - key:
+ - whenField
+ - whenField
+ properties:
+ category:
+ items:
+ type: string
+ type: array
+ mandatory:
+ type: boolean
+ whenField:
+ items:
+ additionalProperties:
+ items:
+ type: string
+ type: array
+ type: object
+ type: array
+ type: object
+ SMTemplateFieldPropertiesRoot:
+ example:
+ data:
+ key:
+ category:
+ - category
+ - category
+ mandatory: true
+ whenField:
+ - key:
+ - whenField
+ - whenField
+ - key:
+ - whenField
+ - whenField
+ meta: '{}'
properties:
data:
additionalProperties:
- $ref: '#/components/schemas/SPARCalculationParameters'
- description: List of calculation parameters.
+ $ref: '#/components/schemas/SMTemplateFieldProperties'
type: object
meta:
- $ref: '#/components/schemas/CalculationMeta'
+ type: object
+ required:
+ - data
type: object
PAComponentData:
- additionalProperties: false
example:
currencyisocode: currencyisocode
componentdetail: componentdetail
@@ -43927,7 +41897,6 @@ components:
type: string
type: object
TemplatedPAComponentParameters:
- additionalProperties: false
example:
parentTemplateId: parentTemplateId
description: description
@@ -43988,7 +41957,6 @@ components:
- parentTemplateId
type: object
TemplatedPAComponentParametersRoot:
- additionalProperties: false
example:
data:
parentTemplateId: parentTemplateId
@@ -44043,7 +42011,6 @@ components:
- data
type: object
TemplatedPAComponentPostSummary:
- additionalProperties: false
example:
parentTemplateId: parentTemplateId
name: name
@@ -44063,7 +42030,6 @@ components:
type: string
type: object
TemplatedPAComponentPostSummaryRoot:
- additionalProperties: false
example:
data:
parentTemplateId: parentTemplateId
@@ -44081,7 +42047,6 @@ components:
- data
type: object
TemplatedPAComponentSummary:
- additionalProperties: false
example:
parentTemplateId: parentTemplateId
name: name
@@ -44098,7 +42063,6 @@ components:
type: string
type: object
TemplatedPAComponentSummaryRoot:
- additionalProperties: false
example:
data:
key:
@@ -44118,7 +42082,6 @@ components:
- data
type: object
TemplatedPAComponentUpdateParameters:
- additionalProperties: false
example:
parentTemplateId: parentTemplateId
description: description
@@ -44172,7 +42135,6 @@ components:
$ref: '#/components/schemas/PAComponentData'
type: object
TemplatedPAComponentUpdateParametersRoot:
- additionalProperties: false
example:
data:
parentTemplateId: parentTemplateId
@@ -44226,7 +42188,6 @@ components:
- data
type: object
TemplatedPAComponent:
- additionalProperties: false
example:
parentTemplateId: parentTemplateId
name: name
@@ -44293,7 +42254,6 @@ components:
type: string
type: object
TemplatedPAComponentRoot:
- additionalProperties: false
example:
data:
parentTemplateId: parentTemplateId
@@ -44352,7 +42312,6 @@ components:
- data
type: object
UnlinkedPATemplateParameters:
- additionalProperties: false
example:
templateTypeId: templateTypeId
currencyisocode: currencyisocode
@@ -44452,7 +42411,6 @@ components:
- templateTypeId
type: object
UnlinkedPATemplateParametersRoot:
- additionalProperties: false
example:
data:
templateTypeId: templateTypeId
@@ -44516,7 +42474,6 @@ components:
- data
type: object
UnlinkedPATemplatePostSummary:
- additionalProperties: false
example:
name: name
description: description
@@ -44537,7 +42494,6 @@ components:
type: string
type: object
UnlinkedPATemplatePostSummaryRoot:
- additionalProperties: false
example:
data:
name: name
@@ -44554,7 +42510,6 @@ components:
- data
type: object
UnlinkedPATemplateSummary:
- additionalProperties: false
example:
name: name
description: description
@@ -44571,7 +42526,6 @@ components:
type: string
type: object
UnlinkedPATemplateSummaryRoot:
- additionalProperties: false
example:
data:
key:
@@ -44590,7 +42544,6 @@ components:
- data
type: object
UnlinkedPATemplateUpdateParameters:
- additionalProperties: false
example:
currencyisocode: currencyisocode
componentdetail: componentdetail
@@ -44679,7 +42632,6 @@ components:
$ref: '#/components/schemas/TemplateContentTypes'
type: object
UnlinkedPATemplateUpdateParametersRoot:
- additionalProperties: false
example:
data:
currencyisocode: currencyisocode
@@ -44741,7 +42693,6 @@ components:
- data
type: object
UnlinkedPATemplate:
- additionalProperties: false
example:
columns:
- id: id
@@ -44854,7 +42805,6 @@ components:
type: string
type: object
UnlinkedPATemplateRoot:
- additionalProperties: false
example:
data:
columns:
@@ -44922,7 +42872,6 @@ components:
- data
type: object
UnlinkedPATemplateCategoryAndType:
- additionalProperties: false
example:
name: name
category: category
@@ -44935,7 +42884,6 @@ components:
type: string
type: object
UnlinkedPATemplateCategoryAndTypeRoot:
- additionalProperties: false
example:
data:
key:
@@ -44953,7 +42901,6 @@ components:
- data
type: object
UnlinkedPATemplateColumnDetails:
- additionalProperties: false
example:
name: name
id: id
@@ -44974,7 +42921,6 @@ components:
type: array
type: object
UnlinkedPATemplateGroupDetails:
- additionalProperties: false
example:
name: name
id: id
@@ -44991,7 +42937,6 @@ components:
type: string
type: object
UnlinkedPATemplateCategoryAndTypeDetails:
- additionalProperties: false
example:
columns:
- name: name
@@ -45040,7 +42985,6 @@ components:
type: string
type: object
UnlinkedPATemplateCategoryAndTypeDetailsRoot:
- additionalProperties: false
example:
data:
columns:
@@ -45074,8 +43018,38 @@ components:
required:
- data
type: object
+ VaultAttributionLoaderResponse:
+ example:
+ processId: processId
+ groupId: groupId
+ objectId: objectId
+ properties:
+ processId:
+ description: ProcessId.
+ type: string
+ groupId:
+ description: GroupId.
+ type: string
+ objectId:
+ description: ObjectId.
+ type: string
+ type: object
+ VaultAttributionLoaderResponseRoot:
+ example:
+ data:
+ processId: processId
+ groupId: groupId
+ objectId: objectId
+ meta: '{}'
+ properties:
+ data:
+ $ref: '#/components/schemas/VaultAttributionLoaderResponse'
+ meta:
+ type: object
+ required:
+ - data
+ type: object
VaultCalculationParameters:
- additionalProperties: false
example:
componentdetail: componentdetail
componentid: componentid
@@ -45107,7 +43081,6 @@ components:
- configid
type: object
VaultCalculationParametersRoot:
- additionalProperties: false
example:
data:
key:
@@ -45134,6 +43107,13 @@ components:
meta:
$ref: '#/components/schemas/CalculationMeta'
type: object
+ inline_object:
+ properties:
+ file:
+ format: binary
+ nullable: true
+ type: string
+ type: object
securitySchemes:
Basic:
description: Input your username and password to access this API
diff --git a/auto-generated-sdk/docs/AccountsApi.md b/auto-generated-sdk/docs/AccountsApi.md
index ce135a91..f7faf5e4 100644
--- a/auto-generated-sdk/docs/AccountsApi.md
+++ b/auto-generated-sdk/docs/AccountsApi.md
@@ -6,7 +6,6 @@ All URIs are relative to *https://api.factset.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getAccounts**](AccountsApi.md#getAccounts) | **GET** /analytics/lookups/v3/accounts/{path} | Get accounts and sub-directories in a directory
-[**getSPARReturnsType**](AccountsApi.md#getSPARReturnsType) | **GET** /analytics/engines/spar/v3/accounts/{accountPath}/returns-type | Get SPAR account returns type details
@@ -44,7 +43,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
AccountsApi apiInstance = new AccountsApi(defaultClient);
- String path = ""; // String | The directory to get the accounts and sub-directories in
+ String path = ""; // String | The directory to get the accounts and sub-directories.
try {
AccountDirectoriesRoot result = apiInstance.getAccounts(path);
System.out.println(result);
@@ -64,7 +63,7 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **path** | **String**| The directory to get the accounts and sub-directories in | [default to ]
+ **path** | **String**| The directory to get the accounts and sub-directories. | [default to ]
### Return type
@@ -92,86 +91,3 @@ Name | Type | Description | Notes
| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
| **503** | Request timed out. Retry the request in some time | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-
-## getSPARReturnsType
-
-> SPARAccountsRoot getSPARReturnsType(accountPath)
-
-Get SPAR account returns type details
-
-This endpoint returns the returns type of account associated with SPAR
-
-### Example
-
-```java
-// Import classes:
-import factset.analyticsapi.engines.ApiClient;
-import factset.analyticsapi.engines.ApiException;
-import factset.analyticsapi.engines.Configuration;
-import factset.analyticsapi.engines.auth.*;
-import factset.analyticsapi.engines.model.*;
-import factset.analyticsapi.engines.api.AccountsApi;
-
-public class Example {
- 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 accountPath = "accountPath_example"; // String | URL encoded account path
- try {
- SPARAccountsRoot result = apiInstance.getSPARReturnsType(accountPath);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling AccountsApi#getSPARReturnsType");
- System.err.println("Status code: " + e.getCode());
- System.err.println("Reason: " + e.getClientErrorResponse());
- System.err.println("Response headers: " + e.getResponseHeaders());
- e.printStackTrace();
- }
- }
-}
-```
-
-### Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **accountPath** | **String**| URL encoded account path |
-
-### Return type
-
-[**SPARAccountsRoot**](SPARAccountsRoot.md)
-
-### Authorization
-
-[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Expected response, returns the list of return types for the account. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **400** | Invalid account. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **404** | Account not found. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
-| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-
diff --git a/auto-generated-sdk/docs/CalculationUnitStatus.md b/auto-generated-sdk/docs/CalculationUnitStatus.md
index adfd1dcc..bdb23f1b 100644
--- a/auto-generated-sdk/docs/CalculationUnitStatus.md
+++ b/auto-generated-sdk/docs/CalculationUnitStatus.md
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
**result** | **String** | The result URL of the calculation. | [optional]
**progress** | **String** | The progress of the calculation unit. | [optional]
**points** | **Integer** | The points for the calculation unit. | [optional]
+**warnings** | **java.util.List<String>** | The warnings in a calculation unit. | [optional]
diff --git a/auto-generated-sdk/docs/ColumnsApi.md b/auto-generated-sdk/docs/ColumnsApi.md
index a1777573..29a80a14 100644
--- a/auto-generated-sdk/docs/ColumnsApi.md
+++ b/auto-generated-sdk/docs/ColumnsApi.md
@@ -44,7 +44,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
ColumnsApi apiInstance = new ColumnsApi(defaultClient);
- String id = "id_example"; // String | Unique identifier for a column
+ String id = "2DBD317E3C235BC96E2FF8CA36CE036AF2F7F55525479B524AE78FD7D6BBC4A7"; // String | Unique identifier for a column
try {
ColumnRoot result = apiInstance.getPAColumnById(id);
System.out.println(result);
diff --git a/auto-generated-sdk/docs/ComponentsApi.md b/auto-generated-sdk/docs/ComponentsApi.md
index 5cd705b2..cc2aefc3 100644
--- a/auto-generated-sdk/docs/ComponentsApi.md
+++ b/auto-generated-sdk/docs/ComponentsApi.md
@@ -7,7 +7,6 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**getPAComponentById**](ComponentsApi.md#getPAComponentById) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id
[**getPAComponents**](ComponentsApi.md#getPAComponents) | **GET** /analytics/engines/pa/v3/components | Get PA components
-[**getSPARComponents**](ComponentsApi.md#getSPARComponents) | **GET** /analytics/engines/spar/v3/components | Get SPAR components
[**getVaultComponentById**](ComponentsApi.md#getVaultComponentById) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id
[**getVaultComponents**](ComponentsApi.md#getVaultComponents) | **GET** /analytics/engines/vault/v3/components | Get Vault components
@@ -47,7 +46,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
ComponentsApi apiInstance = new ComponentsApi(defaultClient);
- String id = "id_example"; // String | Unique identifier for a PA component
+ String id = "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46"; // String | Unique identifier for a PA component
try {
PAComponentRoot result = apiInstance.getPAComponentById(id);
System.out.println(result);
@@ -130,7 +129,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
ComponentsApi apiInstance = new ComponentsApi(defaultClient);
- String document = "document_example"; // String | Document Name
+ String document = "PA3_DOCUMENTS:DEFAULT"; // String | Document Name
try {
ComponentSummaryRoot result = apiInstance.getPAComponents(document);
System.out.println(result);
@@ -179,89 +178,6 @@ Name | Type | Description | Notes
| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-## getSPARComponents
-
-> ComponentSummaryRoot getSPARComponents(document)
-
-Get SPAR components
-
-This endpoint returns the list of SPAR components in a given SPAR document.
-
-### Example
-
-```java
-// Import classes:
-import factset.analyticsapi.engines.ApiClient;
-import factset.analyticsapi.engines.ApiException;
-import factset.analyticsapi.engines.Configuration;
-import factset.analyticsapi.engines.auth.*;
-import factset.analyticsapi.engines.model.*;
-import factset.analyticsapi.engines.api.ComponentsApi;
-
-public class Example {
- 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");
-
- ComponentsApi apiInstance = new ComponentsApi(defaultClient);
- String document = "document_example"; // String | Document Name
- try {
- ComponentSummaryRoot result = apiInstance.getSPARComponents(document);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling ComponentsApi#getSPARComponents");
- System.err.println("Status code: " + e.getCode());
- System.err.println("Reason: " + e.getClientErrorResponse());
- System.err.println("Response headers: " + e.getResponseHeaders());
- e.printStackTrace();
- }
- }
-}
-```
-
-### Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **document** | **String**| Document Name |
-
-### Return type
-
-[**ComponentSummaryRoot**](ComponentSummaryRoot.md)
-
-### Authorization
-
-[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Expected response, returns a list of SPAR components. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **400** | Invalid query parameter provided or Invalid SPAR document name. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **404** | SPAR Document not found. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
-| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-
-
## getVaultComponentById
> VaultComponentRoot getVaultComponentById(id)
diff --git a/auto-generated-sdk/docs/DatesApi.md b/auto-generated-sdk/docs/DatesApi.md
index dd1f7700..1eae45e1 100644
--- a/auto-generated-sdk/docs/DatesApi.md
+++ b/auto-generated-sdk/docs/DatesApi.md
@@ -44,10 +44,10 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
DatesApi apiInstance = new DatesApi(defaultClient);
- String enddate = "enddate_example"; // String | End Date
- String componentid = "componentid_example"; // String | Component Id
- String account = "account_example"; // String | Account
- String startdate = "startdate_example"; // String | Start Date
+ String enddate = "-1AY"; // String | End Date
+ String componentid = "801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46"; // String | Component Id
+ String account = "Account Name"; // String | Account ( Should be in Format - AccountName.ACCT )
+ String startdate = "-3AY"; // String | Start Date
try {
DateParametersSummaryRoot result = apiInstance.convertPADatesToAbsoluteFormat(enddate, componentid, account, startdate);
System.out.println(result);
@@ -69,7 +69,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**enddate** | **String**| End Date |
**componentid** | **String**| Component Id |
- **account** | **String**| Account |
+ **account** | **String**| Account ( Should be in Format - AccountName.ACCT ) |
**startdate** | **String**| Start Date | [optional]
### Return type
diff --git a/auto-generated-sdk/docs/DocumentsApi.md b/auto-generated-sdk/docs/DocumentsApi.md
index f0abdbe5..e1898123 100644
--- a/auto-generated-sdk/docs/DocumentsApi.md
+++ b/auto-generated-sdk/docs/DocumentsApi.md
@@ -7,7 +7,6 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**getPA3Documents**](DocumentsApi.md#getPA3Documents) | **GET** /analytics/engines/pa/v3/documents/{path} | Get PA3 documents and sub-directories in a directory
[**getPubDocuments**](DocumentsApi.md#getPubDocuments) | **GET** /analytics/engines/pub/v3/documents/{path} | Gets Publisher documents and sub-directories in a directory
-[**getSPAR3Documents**](DocumentsApi.md#getSPAR3Documents) | **GET** /analytics/engines/spar/v3/documents/{path} | Gets SPAR3 documents and sub-directories in a directory
[**getVaultDocuments**](DocumentsApi.md#getVaultDocuments) | **GET** /analytics/engines/vault/v3/documents/{path} | Get Vault documents and sub-directories in a directory
@@ -178,89 +177,6 @@ Name | Type | Description | Notes
| **503** | Request timed out. Retry the request in some time | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-## getSPAR3Documents
-
-> DocumentDirectoriesRoot getSPAR3Documents(path)
-
-Gets SPAR3 documents and sub-directories in a directory
-
-This endpoint looks up all SPAR3 documents and sub-directories in a given directory.
-
-### Example
-
-```java
-// Import classes:
-import factset.analyticsapi.engines.ApiClient;
-import factset.analyticsapi.engines.ApiException;
-import factset.analyticsapi.engines.Configuration;
-import factset.analyticsapi.engines.auth.*;
-import factset.analyticsapi.engines.model.*;
-import factset.analyticsapi.engines.api.DocumentsApi;
-
-public class Example {
- 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");
-
- DocumentsApi apiInstance = new DocumentsApi(defaultClient);
- String path = ""; // String | The directory to get the documents in
- try {
- DocumentDirectoriesRoot result = apiInstance.getSPAR3Documents(path);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling DocumentsApi#getSPAR3Documents");
- System.err.println("Status code: " + e.getCode());
- System.err.println("Reason: " + e.getClientErrorResponse());
- System.err.println("Response headers: " + e.getResponseHeaders());
- e.printStackTrace();
- }
- }
-}
-```
-
-### Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **path** | **String**| The directory to get the documents in | [default to ]
-
-### Return type
-
-[**DocumentDirectoriesRoot**](DocumentDirectoriesRoot.md)
-
-### Authorization
-
-[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Expected response, returns a list of SPAR3 documents and directories | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **400** | Invalid query parameter or value provided | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **404** | Path not found | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **401** | Missing or invalid authentication | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **406** | Unsupported Accept header. Header needs to be set to application/json | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
-| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **503** | Request timed out. Retry the request in some time | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-
-
## getVaultDocuments
> DocumentDirectoriesRoot getVaultDocuments(path)
diff --git a/auto-generated-sdk/docs/FrequenciesApi.md b/auto-generated-sdk/docs/FrequenciesApi.md
index 3a93493a..df6d008c 100644
--- a/auto-generated-sdk/docs/FrequenciesApi.md
+++ b/auto-generated-sdk/docs/FrequenciesApi.md
@@ -6,7 +6,6 @@ All URIs are relative to *https://api.factset.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getPAFrequencies**](FrequenciesApi.md#getPAFrequencies) | **GET** /analytics/engines/pa/v3/frequencies | Get PA frequencies
-[**getSPARFrequencies**](FrequenciesApi.md#getSPARFrequencies) | **GET** /analytics/engines/spar/v3/frequencies | Get SPAR frequencies
[**getVaultFrequencies**](FrequenciesApi.md#getVaultFrequencies) | **GET** /analytics/engines/vault/v3/frequencies | Get Vault frequencies
@@ -88,83 +87,6 @@ This endpoint does not need any parameter.
| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-## getSPARFrequencies
-
-> FrequencyRoot getSPARFrequencies()
-
-Get SPAR frequencies
-
-This endpoint lists all the frequencies that can be applied to a SPAR calculation.
-
-### Example
-
-```java
-// Import classes:
-import factset.analyticsapi.engines.ApiClient;
-import factset.analyticsapi.engines.ApiException;
-import factset.analyticsapi.engines.Configuration;
-import factset.analyticsapi.engines.auth.*;
-import factset.analyticsapi.engines.model.*;
-import factset.analyticsapi.engines.api.FrequenciesApi;
-
-public class Example {
- 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");
-
- FrequenciesApi apiInstance = new FrequenciesApi(defaultClient);
- try {
- FrequencyRoot result = apiInstance.getSPARFrequencies();
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling FrequenciesApi#getSPARFrequencies");
- System.err.println("Status code: " + e.getCode());
- System.err.println("Reason: " + e.getClientErrorResponse());
- System.err.println("Response headers: " + e.getResponseHeaders());
- e.printStackTrace();
- }
- }
-}
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**FrequencyRoot**](FrequencyRoot.md)
-
-### Authorization
-
-[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Expected response, returns a list of SPAR frequencies. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
-| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-
-
## getVaultFrequencies
> FrequencyRoot getVaultFrequencies()
diff --git a/auto-generated-sdk/docs/LinkedPaTemplatesApi.md b/auto-generated-sdk/docs/LinkedPaTemplatesApi.md
index 3e28b230..38d7bbe5 100644
--- a/auto-generated-sdk/docs/LinkedPaTemplatesApi.md
+++ b/auto-generated-sdk/docs/LinkedPaTemplatesApi.md
@@ -143,7 +143,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient);
- String id = "id_example"; // String | Unique identifier for a linked PA template
+ String id = "01234567890123456789012345678901"; // String | Unique identifier for a linked PA template
try {
apiInstance.deleteLinkedPATemplates(id);
} catch (ApiException e) {
@@ -225,7 +225,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient);
- String directory = "directory_example"; // String | Get linked PA templates in path.
+ String directory = "Personal:LinkedPATemplates/"; // String | Get linked PA templates in path.
String documentDirectory = "documentDirectory_example"; // String | Get linked PA templates for documents in document path
String documentName = "documentName_example"; // String | Get linked PA templates for documents by document name
try {
@@ -312,7 +312,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient);
- String id = "id_example"; // String | Unique identifier for a linked PA template
+ String id = "01234567890123456789012345678901"; // String | Unique identifier for a linked PA template
try {
LinkedPATemplateRoot result = apiInstance.getLinkedPATemplatesById(id);
System.out.println(result);
@@ -408,7 +408,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
LinkedPaTemplatesApi apiInstance = new LinkedPaTemplatesApi(defaultClient);
- String id = "id_example"; // String | Unique identifier for a linked PA template
+ String id = "01234567890123456789012345678901"; // String | Unique identifier for a linked PA template
LinkedPATemplateUpdateParametersRoot linkedPATemplateUpdateParametersRoot = new LinkedPATemplateUpdateParametersRoot(); // LinkedPATemplateUpdateParametersRoot | Request Parameters
try {
LinkedPATemplatePostSummaryRoot result = apiInstance.updateLinkedPATemplates(id, linkedPATemplateUpdateParametersRoot);
diff --git a/auto-generated-sdk/docs/OneOfFieldsFields.md b/auto-generated-sdk/docs/OneOfFieldsFields.md
new file mode 100644
index 00000000..23f3814a
--- /dev/null
+++ b/auto-generated-sdk/docs/OneOfFieldsFields.md
@@ -0,0 +1,37 @@
+
+
+# OneOfFieldsFields
+
+## oneOf schemas
+* [SMBondFields](SMBondFields.md)
+* [SMCustomCashFlowFields](SMCustomCashFlowFields.md)
+
+## Example
+```java
+// Import classes:
+import factset.analyticsapi.engines.models.OneOfFieldsFields;
+import factset.analyticsapi.engines.models.SMBondFields;
+import factset.analyticsapi.engines.models.SMCustomCashFlowFields;
+
+public class Example {
+ public static void main(String[] args) {
+ OneOfFieldsFields exampleOneOfFieldsFields = new OneOfFieldsFields();
+
+ // create a new SMBondFields
+ SMBondFields exampleSMBondFields = new SMBondFields();
+ // set OneOfFieldsFields to SMBondFields
+ exampleOneOfFieldsFields.setActualInstance(exampleSMBondFields);
+ // to get back the SMBondFields set earlier
+ SMBondFields testSMBondFields = (SMBondFields) exampleOneOfFieldsFields.getActualInstance();
+
+ // create a new SMCustomCashFlowFields
+ SMCustomCashFlowFields exampleSMCustomCashFlowFields = new SMCustomCashFlowFields();
+ // set OneOfFieldsFields to SMCustomCashFlowFields
+ exampleOneOfFieldsFields.setActualInstance(exampleSMCustomCashFlowFields);
+ // to get back the SMCustomCashFlowFields set earlier
+ SMCustomCashFlowFields testSMCustomCashFlowFields = (SMCustomCashFlowFields) exampleOneOfFieldsFields.getActualInstance();
+ }
+}
+```
+
+
diff --git a/auto-generated-sdk/docs/OneOfSMFields.md b/auto-generated-sdk/docs/OneOfSMFields.md
new file mode 100644
index 00000000..d4824b5b
--- /dev/null
+++ b/auto-generated-sdk/docs/OneOfSMFields.md
@@ -0,0 +1,37 @@
+
+
+# OneOfSMFields
+
+## oneOf schemas
+* [SMBondFields](SMBondFields.md)
+* [SMCustomCashFlowFields](SMCustomCashFlowFields.md)
+
+## Example
+```java
+// Import classes:
+import factset.analyticsapi.engines.models.OneOfSMFields;
+import factset.analyticsapi.engines.models.SMBondFields;
+import factset.analyticsapi.engines.models.SMCustomCashFlowFields;
+
+public class Example {
+ public static void main(String[] args) {
+ OneOfSMFields exampleOneOfSMFields = new OneOfSMFields();
+
+ // create a new SMBondFields
+ SMBondFields exampleSMBondFields = new SMBondFields();
+ // set OneOfSMFields to SMBondFields
+ exampleOneOfSMFields.setActualInstance(exampleSMBondFields);
+ // to get back the SMBondFields set earlier
+ SMBondFields testSMBondFields = (SMBondFields) exampleOneOfSMFields.getActualInstance();
+
+ // create a new SMCustomCashFlowFields
+ SMCustomCashFlowFields exampleSMCustomCashFlowFields = new SMCustomCashFlowFields();
+ // set OneOfSMFields to SMCustomCashFlowFields
+ exampleOneOfSMFields.setActualInstance(exampleSMCustomCashFlowFields);
+ // to get back the SMCustomCashFlowFields set earlier
+ SMCustomCashFlowFields testSMCustomCashFlowFields = (SMCustomCashFlowFields) exampleOneOfSMFields.getActualInstance();
+ }
+}
+```
+
+
diff --git a/auto-generated-sdk/docs/QuantCalculationsApi.md b/auto-generated-sdk/docs/QuantCalculationsApi.md
index 4e55b5b6..68c4ea13 100644
--- a/auto-generated-sdk/docs/QuantCalculationsApi.md
+++ b/auto-generated-sdk/docs/QuantCalculationsApi.md
@@ -581,7 +581,7 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: application/json
-- **Accept**: application/json, application/x-protobuf
+- **Accept**: application/json, application/x-protobuf, application/octet-stream
### HTTP response details
| Status code | Description | Response headers |
@@ -591,6 +591,7 @@ Name | Type | Description | Notes
| **200** | Expected response if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| **400** | Invalid calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **413** | Request body too large | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
@@ -682,6 +683,7 @@ Name | Type | Description | Notes
| **400** | Invalid Calculation Parameters. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| **409** | Duplicate calculation exists with same parameters. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **413** | Request body too large | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
diff --git a/auto-generated-sdk/docs/SMBondFields.md b/auto-generated-sdk/docs/SMBondFields.md
new file mode 100644
index 00000000..fe4d056f
--- /dev/null
+++ b/auto-generated-sdk/docs/SMBondFields.md
@@ -0,0 +1,149 @@
+
+
+# SMBondFields
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_144aFlag** | **Boolean** | | [optional]
+**aperiodicMultipliers** | **java.util.List<Double>** | | [optional]
+**aperiodicResetDates** | **java.util.List<String>** | | [optional]
+**aperiodicSpreads** | **java.util.List<Double>** | | [optional]
+**businessDayConv** | **String** | | [optional]
+**callAnnouncedDate** | **String** | | [optional]
+**callDates** | **java.util.List<String>** | | [optional]
+**callFreq** | **String** | | [optional]
+**callNoticeDays** | **Integer** | | [optional]
+**callPrices** | **java.util.List<Double>** | | [optional]
+**cashRate** | **Double** | | [optional]
+**cognity** | **String** | | [optional]
+**conversionIdentifier** | **String** | | [optional]
+**conversionRatio** | **Double** | | [optional]
+**conversionType** | **String** | | [optional]
+**convertibleFlag** | **Boolean** | | [optional]
+**country** | **String** | | [optional]
+**coupon** | **Double** | | [optional]
+**couponType** | **String** | | [optional]
+**creditSpreadAdjustmentSingle** | **Double** | | [optional]
+**currency** | **String** | | [optional]
+**dayCountBasis** | **String** | | [optional]
+**defaultedDate** | **String** | | [optional]
+**federalTaxExemptFlag** | **Boolean** | | [optional]
+**firstPayDate** | **String** | | [optional]
+**firstResetDate** | **String** | | [optional]
+**floatFormula** | **String** | | [optional]
+**fltDayCountBasis** | **String** | | [optional]
+**fltFirstPayDate** | **String** | | [optional]
+**fltPayFreq** | **String** | | [optional]
+**histCouponDates** | **java.util.List<String>** | | [optional]
+**histCoupons** | **java.util.List<Double>** | | [optional]
+**histRcvAssumpDates** | **java.util.List<String>** | | [optional]
+**histRcvAssumpMonths** | **java.util.List<Integer>** | | [optional]
+**histRcvAssumpRates** | **java.util.List<Double>** | | [optional]
+**histRcvAssumpTargetDates** | **java.util.List<String>** | | [optional]
+**inflationType** | **String** | | [optional]
+**issueDate** | **String** | | [optional]
+**issueName** | **String** | | [optional]
+**issuerId** | **String** | | [optional]
+**lastModifiedSource** | **String** | | [optional]
+**lastModifiedSourceMeta** | **String** | | [optional]
+**lastModifiedTime** | **String** | | [optional]
+**lifeCap** | **Double** | | [optional]
+**lifeFloor** | **Double** | | [optional]
+**lockoutDays** | **Integer** | | [optional]
+**lookBackDays** | **Integer** | | [optional]
+**makeWholeCallFlag** | **Boolean** | | [optional]
+**makeWholeExpireDate** | **String** | | [optional]
+**makeWholeSpread** | **Double** | | [optional]
+**matrixDates** | **java.util.List<String>** | | [optional]
+**matrixMultipliers** | **java.util.List<Double>** | | [optional]
+**matrixPricedFlag** | **Boolean** | | [optional]
+**matrixSpreads** | **java.util.List<Double>** | | [optional]
+**matrixUseScheduleFlag** | **Boolean** | | [optional]
+**maturityDate** | **String** | | [optional]
+**maturityPrice** | **Double** | | [optional]
+**monthsToRecovery** | **Double** | | [optional]
+**multiplier** | **Double** | | [optional]
+**notionalFlag** | **Boolean** | | [optional]
+**observationShift** | **Integer** | | [optional]
+**origAmtIssued** | **Double** | | [optional]
+**parentName** | **String** | | [optional]
+**parPrice** | **Double** | | [optional]
+**parserInfo** | **String** | | [optional]
+**paymentDelay** | **Integer** | | [optional]
+**payFreq** | **String** | | [optional]
+**periodCap** | **Double** | | [optional]
+**periodFloor** | **Double** | | [optional]
+**pikExpDate** | **String** | | [optional]
+**pikRate** | **Integer** | | [optional]
+**preferredSecExDateLen** | **Integer** | | [optional]
+**preferredSecExDateUnits** | **String** | | [optional]
+**preferredSecFlag** | **Boolean** | | [optional]
+**preferredSecType** | **String** | | [optional]
+**principalType** | **String** | | [optional]
+**putDates** | **java.util.List<String>** | | [optional]
+**putNoticeDays** | **Integer** | | [optional]
+**putFreq** | **String** | | [optional]
+**putPrices** | **java.util.List<Double>** | | [optional]
+**pvtPlacementFlag** | **Boolean** | | [optional]
+**ratingFitch** | **String** | | [optional]
+**ratingFitchDates** | **java.util.List<String>** | | [optional]
+**ratingFitchValues** | **java.util.List<String>** | | [optional]
+**ratingMoodysDates** | **java.util.List<String>** | | [optional]
+**ratingMoodysValues** | **java.util.List<String>** | | [optional]
+**ratingSpDates** | **java.util.List<String>** | | [optional]
+**ratingSpValues** | **java.util.List<String>** | | [optional]
+**recoveryPercentage** | **Double** | | [optional]
+**redemptionDate** | **String** | | [optional]
+**redemptionOpt** | **String** | | [optional]
+**redemptionPrice** | **Double** | | [optional]
+**reinstatedDate** | **String** | | [optional]
+**resetDelay** | **Integer** | | [optional]
+**resetFreq** | **String** | | [optional]
+**refIndex** | **String** | | [optional]
+**secondaryToVendorFlag** | **Boolean** | | [optional]
+**sector** | **String** | | [optional]
+**sectorBarclay1** | **String** | | [optional]
+**sectorBarclay2** | **String** | | [optional]
+**sectorBarclay3** | **String** | | [optional]
+**sectorBarclay4** | **String** | | [optional]
+**sectorDef** | **String** | | [optional]
+**sectorIndustry** | **String** | | [optional]
+**sectorMain** | **String** | | [optional]
+**sectorMerrill1** | **String** | | [optional]
+**sectorMerrill2** | **String** | | [optional]
+**sectorMerrill3** | **String** | | [optional]
+**sectorMerrill4** | **String** | | [optional]
+**sectorSubGroup** | **String** | | [optional]
+**sinkAmts** | **java.util.List<Double>** | | [optional]
+**sinkDates** | **java.util.List<String>** | | [optional]
+**spread** | **Double** | | [optional]
+**state** | **String** | | [optional]
+**status** | **String** | | [optional]
+**statusDates** | **java.util.List<String>** | | [optional]
+**statusValues** | **java.util.List<String>** | | [optional]
+**stepCashRates** | **java.util.List<Double>** | | [optional]
+**stepCouponDates** | **java.util.List<String>** | | [optional]
+**stepCoupons** | **java.util.List<Double>** | | [optional]
+**stepPikRates** | **java.util.List<Double>** | | [optional]
+**vendorCoverageDate** | **String** | | [optional]
+**vRDNFlag** | **Boolean** | | [optional]
+**securityType** | [**SecurityTypeEnum**](#SecurityTypeEnum) | |
+
+
+
+## Enum: SecurityTypeEnum
+
+Name | Value
+---- | -----
+BOND | "Bond"
+CCF | "CCF"
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SMCreateParameters.md b/auto-generated-sdk/docs/SMCreateParameters.md
new file mode 100644
index 00000000..d96836a3
--- /dev/null
+++ b/auto-generated-sdk/docs/SMCreateParameters.md
@@ -0,0 +1,20 @@
+
+
+# SMCreateParameters
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**securityName** | **String** | |
+**location** | **String** | | [optional]
+**asofdate** | **String** | | [optional]
+**fields** | [**OneOfSMFields**](OneOfSMFields.md) | |
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SMCreateParametersRoot.md b/auto-generated-sdk/docs/SMCreateParametersRoot.md
new file mode 100644
index 00000000..7a4f5d76
--- /dev/null
+++ b/auto-generated-sdk/docs/SMCreateParametersRoot.md
@@ -0,0 +1,18 @@
+
+
+# SMCreateParametersRoot
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**java.util.List<SMCreateParameters>**](SMCreateParameters.md) | |
+**meta** | **Object** | | [optional]
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SMCreateResponse.md b/auto-generated-sdk/docs/SMCreateResponse.md
new file mode 100644
index 00000000..608088b7
--- /dev/null
+++ b/auto-generated-sdk/docs/SMCreateResponse.md
@@ -0,0 +1,29 @@
+
+
+# SMCreateResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**securityName** | **String** | | [optional]
+**status** | [**StatusEnum**](#StatusEnum) | | [optional]
+**warnings** | [**java.util.List<SMWarning>**](SMWarning.md) | | [optional]
+**errors** | [**java.util.List<SMError>**](SMError.md) | | [optional]
+
+
+
+## Enum: StatusEnum
+
+Name | Value
+---- | -----
+SUCCESS | "success"
+FAILURE | "failure"
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SPARBenchmarkRoot.md b/auto-generated-sdk/docs/SMCreateResponseRoot.md
similarity index 65%
rename from auto-generated-sdk/docs/SPARBenchmarkRoot.md
rename to auto-generated-sdk/docs/SMCreateResponseRoot.md
index ec9eafd3..e340d019 100644
--- a/auto-generated-sdk/docs/SPARBenchmarkRoot.md
+++ b/auto-generated-sdk/docs/SMCreateResponseRoot.md
@@ -1,13 +1,13 @@
-# SPARBenchmarkRoot
+# SMCreateResponseRoot
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**data** | [**SPARBenchmark**](SPARBenchmark.md) | |
+**data** | [**java.util.List<SMCreateResponse>**](SMCreateResponse.md) | |
**meta** | **Object** | | [optional]
diff --git a/auto-generated-sdk/docs/SMCustomCashFlowFields.md b/auto-generated-sdk/docs/SMCustomCashFlowFields.md
new file mode 100644
index 00000000..a7e18558
--- /dev/null
+++ b/auto-generated-sdk/docs/SMCustomCashFlowFields.md
@@ -0,0 +1,55 @@
+
+
+# SMCustomCashFlowFields
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cashFlowAmounts** | **java.util.List<Double>** | | [optional]
+**cashFlowDates** | **java.util.List<String>** | | [optional]
+**country** | **String** | | [optional]
+**currency** | **String** | | [optional]
+**issueName** | **String** | | [optional]
+**parAmt** | **Double** | | [optional]
+**parentName** | **String** | | [optional]
+**ratingFitch** | **String** | | [optional]
+**ratingFitchDates** | **java.util.List<String>** | | [optional]
+**ratingFitchValues** | **java.util.List<String>** | | [optional]
+**ratingMoodysDates** | **java.util.List<String>** | | [optional]
+**ratingMoodysValues** | **java.util.List<String>** | | [optional]
+**ratingSpDates** | **java.util.List<String>** | | [optional]
+**ratingSpValues** | **java.util.List<String>** | | [optional]
+**secondaryToVendorFlag** | **Boolean** | | [optional]
+**sector** | **String** | | [optional]
+**sectorBarclay1** | **String** | | [optional]
+**sectorBarclay2** | **String** | | [optional]
+**sectorBarclay3** | **String** | | [optional]
+**sectorBarclay4** | **String** | | [optional]
+**sectorDef** | **String** | | [optional]
+**sectorIndustry** | **String** | | [optional]
+**sectorMain** | **String** | | [optional]
+**sectorMerrill1** | **String** | | [optional]
+**sectorMerrill2** | **String** | | [optional]
+**sectorMerrill3** | **String** | | [optional]
+**sectorMerrill4** | **String** | | [optional]
+**sectorSubGroup** | **String** | | [optional]
+**vendorCoverageDate** | **String** | | [optional]
+**securityType** | [**SecurityTypeEnum**](#SecurityTypeEnum) | |
+
+
+
+## Enum: SecurityTypeEnum
+
+Name | Value
+---- | -----
+BOND | "Bond"
+CCF | "CCF"
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SMDeleteParameters.md b/auto-generated-sdk/docs/SMDeleteParameters.md
new file mode 100644
index 00000000..9daaba2b
--- /dev/null
+++ b/auto-generated-sdk/docs/SMDeleteParameters.md
@@ -0,0 +1,29 @@
+
+
+# SMDeleteParameters
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**securityName** | **String** | |
+**location** | **String** | | [optional]
+**asofdate** | **String** | | [optional]
+**securityType** | [**SecurityTypeEnum**](#SecurityTypeEnum) | | [optional]
+
+
+
+## Enum: SecurityTypeEnum
+
+Name | Value
+---- | -----
+BOND | "Bond"
+CCF | "CCF"
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SMDeleteParametersRoot.md b/auto-generated-sdk/docs/SMDeleteParametersRoot.md
new file mode 100644
index 00000000..8d1126f3
--- /dev/null
+++ b/auto-generated-sdk/docs/SMDeleteParametersRoot.md
@@ -0,0 +1,18 @@
+
+
+# SMDeleteParametersRoot
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**java.util.List<SMDeleteParameters>**](SMDeleteParameters.md) | |
+**meta** | **Object** | | [optional]
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SMDeleteResponse.md b/auto-generated-sdk/docs/SMDeleteResponse.md
new file mode 100644
index 00000000..874cef72
--- /dev/null
+++ b/auto-generated-sdk/docs/SMDeleteResponse.md
@@ -0,0 +1,28 @@
+
+
+# SMDeleteResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**securityName** | **String** | | [optional]
+**status** | [**StatusEnum**](#StatusEnum) | | [optional]
+**errors** | [**java.util.List<SMError>**](SMError.md) | | [optional]
+
+
+
+## Enum: StatusEnum
+
+Name | Value
+---- | -----
+SUCCESS | "success"
+FAILURE | "failure"
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SPARAccountsRoot.md b/auto-generated-sdk/docs/SMDeleteResponseRoot.md
similarity index 65%
rename from auto-generated-sdk/docs/SPARAccountsRoot.md
rename to auto-generated-sdk/docs/SMDeleteResponseRoot.md
index d33075ac..f7f25900 100644
--- a/auto-generated-sdk/docs/SPARAccountsRoot.md
+++ b/auto-generated-sdk/docs/SMDeleteResponseRoot.md
@@ -1,13 +1,13 @@
-# SPARAccountsRoot
+# SMDeleteResponseRoot
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**data** | [**SPARAccounts**](SPARAccounts.md) | |
+**data** | [**java.util.List<SMDeleteResponse>**](SMDeleteResponse.md) | |
**meta** | **Object** | | [optional]
diff --git a/auto-generated-sdk/docs/ReturnType.md b/auto-generated-sdk/docs/SMError.md
similarity index 64%
rename from auto-generated-sdk/docs/ReturnType.md
rename to auto-generated-sdk/docs/SMError.md
index 0951e50d..9daadaec 100644
--- a/auto-generated-sdk/docs/ReturnType.md
+++ b/auto-generated-sdk/docs/SMError.md
@@ -1,14 +1,13 @@
-# ReturnType
+# SMError
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**name** | **String** | | [optional]
-**id** | **String** | | [optional]
+**detail** | **String** | | [optional]
## Implemented Interfaces
diff --git a/auto-generated-sdk/docs/SMFields.md b/auto-generated-sdk/docs/SMFields.md
new file mode 100644
index 00000000..4c394c0d
--- /dev/null
+++ b/auto-generated-sdk/docs/SMFields.md
@@ -0,0 +1,26 @@
+
+
+# SMFields
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**securityType** | [**SecurityTypeEnum**](#SecurityTypeEnum) | |
+
+
+
+## Enum: SecurityTypeEnum
+
+Name | Value
+---- | -----
+BOND | "Bond"
+CCF | "CCF"
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SMRetrieveParameters.md b/auto-generated-sdk/docs/SMRetrieveParameters.md
new file mode 100644
index 00000000..b01006c0
--- /dev/null
+++ b/auto-generated-sdk/docs/SMRetrieveParameters.md
@@ -0,0 +1,29 @@
+
+
+# SMRetrieveParameters
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**securityName** | **String** | |
+**location** | **String** | | [optional]
+**asofdate** | **String** | | [optional]
+**securityType** | [**SecurityTypeEnum**](#SecurityTypeEnum) | | [optional]
+
+
+
+## Enum: SecurityTypeEnum
+
+Name | Value
+---- | -----
+BOND | "Bond"
+CCF | "CCF"
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SMRetrieveParametersRoot.md b/auto-generated-sdk/docs/SMRetrieveParametersRoot.md
new file mode 100644
index 00000000..7020a2ff
--- /dev/null
+++ b/auto-generated-sdk/docs/SMRetrieveParametersRoot.md
@@ -0,0 +1,18 @@
+
+
+# SMRetrieveParametersRoot
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**java.util.List<SMRetrieveParameters>**](SMRetrieveParameters.md) | |
+**meta** | **Object** | | [optional]
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SMRetrieveResponse.md b/auto-generated-sdk/docs/SMRetrieveResponse.md
new file mode 100644
index 00000000..6b173822
--- /dev/null
+++ b/auto-generated-sdk/docs/SMRetrieveResponse.md
@@ -0,0 +1,31 @@
+
+
+# SMRetrieveResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**securityName** | **String** | | [optional]
+**status** | [**StatusEnum**](#StatusEnum) | | [optional]
+**location** | **String** | | [optional]
+**asofdate** | **String** | | [optional]
+**fields** | [**OneOfFieldsFields**](OneOfFieldsFields.md) | | [optional]
+**errors** | [**java.util.List<SMError>**](SMError.md) | | [optional]
+
+
+
+## Enum: StatusEnum
+
+Name | Value
+---- | -----
+SUCCESS | "success"
+FAILURE | "failure"
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SMRetrieveResponseRoot.md b/auto-generated-sdk/docs/SMRetrieveResponseRoot.md
new file mode 100644
index 00000000..5e249bb4
--- /dev/null
+++ b/auto-generated-sdk/docs/SMRetrieveResponseRoot.md
@@ -0,0 +1,18 @@
+
+
+# SMRetrieveResponseRoot
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**java.util.List<SMRetrieveResponse>**](SMRetrieveResponse.md) | |
+**meta** | **Object** | | [optional]
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SMTemplateFieldProperties.md b/auto-generated-sdk/docs/SMTemplateFieldProperties.md
new file mode 100644
index 00000000..33c71ce0
--- /dev/null
+++ b/auto-generated-sdk/docs/SMTemplateFieldProperties.md
@@ -0,0 +1,19 @@
+
+
+# SMTemplateFieldProperties
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | **java.util.List<String>** | | [optional]
+**mandatory** | **Boolean** | | [optional]
+**whenField** | **java.util.List<java.util.Map<String, java.util.List<String>>>** | | [optional]
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SMTemplateFieldPropertiesRoot.md b/auto-generated-sdk/docs/SMTemplateFieldPropertiesRoot.md
new file mode 100644
index 00000000..bd5536d0
--- /dev/null
+++ b/auto-generated-sdk/docs/SMTemplateFieldPropertiesRoot.md
@@ -0,0 +1,18 @@
+
+
+# SMTemplateFieldPropertiesRoot
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Map<String, SMTemplateFieldProperties>**](SMTemplateFieldProperties.md) | |
+**meta** | **Object** | | [optional]
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/SPARAccounts.md b/auto-generated-sdk/docs/SMWarning.md
similarity index 55%
rename from auto-generated-sdk/docs/SPARAccounts.md
rename to auto-generated-sdk/docs/SMWarning.md
index 597adf65..de83bef3 100644
--- a/auto-generated-sdk/docs/SPARAccounts.md
+++ b/auto-generated-sdk/docs/SMWarning.md
@@ -1,13 +1,13 @@
-# SPARAccounts
+# SMWarning
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**returnsType** | [**java.util.List<ReturnType>**](ReturnType.md) | List of SPAR returnsType | [optional]
+**detail** | **String** | | [optional]
## Implemented Interfaces
diff --git a/auto-generated-sdk/docs/SPARBenchmark.md b/auto-generated-sdk/docs/SPARBenchmark.md
deleted file mode 100644
index ade87337..00000000
--- a/auto-generated-sdk/docs/SPARBenchmark.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-
-# SPARBenchmark
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Benchmark identifier | [optional]
-**name** | **String** | Benchmark Name | [optional]
-**identifiers** | [**java.util.List<SPARIdentifier>**](SPARIdentifier.md) | List of SPAR identifiers | [optional]
-
-
-## Implemented Interfaces
-
-* Serializable
-
-
diff --git a/auto-generated-sdk/docs/SPARCalculationParameters.md b/auto-generated-sdk/docs/SPARCalculationParameters.md
deleted file mode 100644
index 4bfd7839..00000000
--- a/auto-generated-sdk/docs/SPARCalculationParameters.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-
-# SPARCalculationParameters
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**componentid** | **String** | The SPAR Engine component identifier to analyze. |
-**accounts** | [**java.util.List<SPARIdentifier>**](SPARIdentifier.md) | List of accounts for SPAR calculation. | [optional]
-**benchmark** | [**SPARIdentifier**](SPARIdentifier.md) | | [optional]
-**dates** | [**SPARDateParameters**](SPARDateParameters.md) | | [optional]
-**currencyisocode** | **String** | Currency ISO code for calculation. | [optional]
-
-
-## Implemented Interfaces
-
-* Serializable
-
-
diff --git a/auto-generated-sdk/docs/SPARCalculationParametersRoot.md b/auto-generated-sdk/docs/SPARCalculationParametersRoot.md
deleted file mode 100644
index d7d23139..00000000
--- a/auto-generated-sdk/docs/SPARCalculationParametersRoot.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-
-# SPARCalculationParametersRoot
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Map<String, SPARCalculationParameters>**](SPARCalculationParameters.md) | List of calculation parameters. | [optional]
-**meta** | [**CalculationMeta**](CalculationMeta.md) | | [optional]
-
-
-## Implemented Interfaces
-
-* Serializable
-
-
diff --git a/auto-generated-sdk/docs/SPARDateParameters.md b/auto-generated-sdk/docs/SPARDateParameters.md
deleted file mode 100644
index 83983c13..00000000
--- a/auto-generated-sdk/docs/SPARDateParameters.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-
-# SPARDateParameters
-
-The date parameters for SPAR calculation.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**startdate** | **String** | Calculation's start date. |
-**enddate** | **String** | Calculation's end date. |
-**frequency** | **String** | Calculation's frequency. |
-
-
-## Implemented Interfaces
-
-* Serializable
-
-
diff --git a/auto-generated-sdk/docs/SPARIdentifier.md b/auto-generated-sdk/docs/SPARIdentifier.md
deleted file mode 100644
index 1faca23a..00000000
--- a/auto-generated-sdk/docs/SPARIdentifier.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-
-# SPARIdentifier
-
-The account/benchmark parameter for SPAR calculation.
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | User's FactSet account OR benchmark id. |
-**returntype** | **String** | Benchmark return type. | [optional]
-**prefix** | **String** | Benchmark prefix. | [optional]
-
-
-## Implemented Interfaces
-
-* Serializable
-
-
diff --git a/auto-generated-sdk/docs/SecurityModelingApi.md b/auto-generated-sdk/docs/SecurityModelingApi.md
new file mode 100644
index 00000000..63660740
--- /dev/null
+++ b/auto-generated-sdk/docs/SecurityModelingApi.md
@@ -0,0 +1,339 @@
+
+# SecurityModelingApi
+
+All URIs are relative to *https://api.factset.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**deleteSecurities**](SecurityModelingApi.md#deleteSecurities) | **POST** /analytics/security-modeling/v3/securities/delete | Delete existing securities
+[**getSecurities**](SecurityModelingApi.md#getSecurities) | **POST** /analytics/security-modeling/v3/securities/retrieve | Get existing securities
+[**getTemplateFields**](SecurityModelingApi.md#getTemplateFields) | **GET** /analytics/security-modeling/v3/templates/{template}/fields | Get template fields
+[**upsertSecurities**](SecurityModelingApi.md#upsertSecurities) | **POST** /analytics/security-modeling/v3/securities/upsert | Create or update securities
+
+
+
+## deleteSecurities
+
+> SMDeleteResponseRoot deleteSecurities(smDeleteParametersRoot)
+
+Delete existing securities
+
+This endpoint deletes existing securities.
+
+### Example
+
+```java
+// Import classes:
+import factset.analyticsapi.engines.ApiClient;
+import factset.analyticsapi.engines.ApiException;
+import factset.analyticsapi.engines.Configuration;
+import factset.analyticsapi.engines.auth.*;
+import factset.analyticsapi.engines.model.*;
+import factset.analyticsapi.engines.api.SecurityModelingApi;
+
+public class Example {
+ 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");
+
+ SecurityModelingApi apiInstance = new SecurityModelingApi(defaultClient);
+ SMDeleteParametersRoot smDeleteParametersRoot = new SMDeleteParametersRoot(); // SMDeleteParametersRoot |
+ try {
+ SMDeleteResponseRoot result = apiInstance.deleteSecurities(smDeleteParametersRoot);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling SecurityModelingApi#deleteSecurities");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getClientErrorResponse());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **smDeleteParametersRoot** | [**SMDeleteParametersRoot**](SMDeleteParametersRoot.md)| | [optional]
+
+### Return type
+
+[**SMDeleteResponseRoot**](SMDeleteResponseRoot.md)
+
+### Authorization
+
+[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Expected response, deletes existing securities. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
+| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
+| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
+| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
+
+
+## getSecurities
+
+> SMRetrieveResponseRoot getSecurities(smRetrieveParametersRoot)
+
+Get existing securities
+
+This endpoint gets all existing securities.
+
+### Example
+
+```java
+// Import classes:
+import factset.analyticsapi.engines.ApiClient;
+import factset.analyticsapi.engines.ApiException;
+import factset.analyticsapi.engines.Configuration;
+import factset.analyticsapi.engines.auth.*;
+import factset.analyticsapi.engines.model.*;
+import factset.analyticsapi.engines.api.SecurityModelingApi;
+
+public class Example {
+ 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");
+
+ SecurityModelingApi apiInstance = new SecurityModelingApi(defaultClient);
+ SMRetrieveParametersRoot smRetrieveParametersRoot = new SMRetrieveParametersRoot(); // SMRetrieveParametersRoot |
+ try {
+ SMRetrieveResponseRoot result = apiInstance.getSecurities(smRetrieveParametersRoot);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling SecurityModelingApi#getSecurities");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getClientErrorResponse());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **smRetrieveParametersRoot** | [**SMRetrieveParametersRoot**](SMRetrieveParametersRoot.md)| | [optional]
+
+### Return type
+
+[**SMRetrieveResponseRoot**](SMRetrieveResponseRoot.md)
+
+### Authorization
+
+[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Expected response, returns a list of existing securities. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
+| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
+| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
+| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
+
+
+## getTemplateFields
+
+> SMTemplateFieldPropertiesRoot getTemplateFields(template)
+
+Get template fields
+
+This endpoint gets template fields.
+
+### Example
+
+```java
+// Import classes:
+import factset.analyticsapi.engines.ApiClient;
+import factset.analyticsapi.engines.ApiException;
+import factset.analyticsapi.engines.Configuration;
+import factset.analyticsapi.engines.auth.*;
+import factset.analyticsapi.engines.model.*;
+import factset.analyticsapi.engines.api.SecurityModelingApi;
+
+public class Example {
+ 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");
+
+ SecurityModelingApi apiInstance = new SecurityModelingApi(defaultClient);
+ String template = "template_example"; // String | Template name
+ try {
+ SMTemplateFieldPropertiesRoot result = apiInstance.getTemplateFields(template);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling SecurityModelingApi#getTemplateFields");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getClientErrorResponse());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **template** | **String**| Template name |
+
+### Return type
+
+[**SMTemplateFieldPropertiesRoot**](SMTemplateFieldPropertiesRoot.md)
+
+### Authorization
+
+[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Expected response, returns a list of all template fields. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **400** | Invalid template. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **404** | Template not found. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
+| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
+| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
+| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
+
+
+## upsertSecurities
+
+> SMCreateResponseRoot upsertSecurities(smCreateParametersRoot)
+
+Create or update securities
+
+This endpoint is to create or update existing securities.
+
+### Example
+
+```java
+// Import classes:
+import factset.analyticsapi.engines.ApiClient;
+import factset.analyticsapi.engines.ApiException;
+import factset.analyticsapi.engines.Configuration;
+import factset.analyticsapi.engines.auth.*;
+import factset.analyticsapi.engines.model.*;
+import factset.analyticsapi.engines.api.SecurityModelingApi;
+
+public class Example {
+ 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");
+
+ SecurityModelingApi apiInstance = new SecurityModelingApi(defaultClient);
+ SMCreateParametersRoot smCreateParametersRoot = new SMCreateParametersRoot(); // SMCreateParametersRoot |
+ try {
+ SMCreateResponseRoot result = apiInstance.upsertSecurities(smCreateParametersRoot);
+ System.out.println(result);
+ } catch (ApiException e) {
+ System.err.println("Exception when calling SecurityModelingApi#upsertSecurities");
+ System.err.println("Status code: " + e.getCode());
+ System.err.println("Reason: " + e.getClientErrorResponse());
+ System.err.println("Response headers: " + e.getResponseHeaders());
+ e.printStackTrace();
+ }
+ }
+}
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **smCreateParametersRoot** | [**SMCreateParametersRoot**](SMCreateParametersRoot.md)| | [optional]
+
+### Return type
+
+[**SMCreateResponseRoot**](SMCreateResponseRoot.md)
+
+### Authorization
+
+[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Expected response, returns a status of operation along with errors and warnings if found any. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
+| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
+| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
+| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
+
diff --git a/auto-generated-sdk/docs/SparCalculationsApi.md b/auto-generated-sdk/docs/SparCalculationsApi.md
deleted file mode 100644
index 61f01786..00000000
--- a/auto-generated-sdk/docs/SparCalculationsApi.md
+++ /dev/null
@@ -1,618 +0,0 @@
-
-# SparCalculationsApi
-
-All URIs are relative to *https://api.factset.com*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**cancelCalculationById**](SparCalculationsApi.md#cancelCalculationById) | **DELETE** /analytics/engines/spar/v3/calculations/{id} | Cancel SPAR calculation
-[**getAllCalculations**](SparCalculationsApi.md#getAllCalculations) | **GET** /analytics/engines/spar/v3/calculations | Get all calculations
-[**getCalculationParameters**](SparCalculationsApi.md#getCalculationParameters) | **GET** /analytics/engines/spar/v3/calculations/{id} | Get SPAR calculation parameters by id
-[**getCalculationStatusById**](SparCalculationsApi.md#getCalculationStatusById) | **GET** /analytics/engines/spar/v3/calculations/{id}/status | Get SPAR calculation status by id
-[**getCalculationUnitResultById**](SparCalculationsApi.md#getCalculationUnitResultById) | **GET** /analytics/engines/spar/v3/calculations/{id}/units/{unitId}/result | Get SPAR calculation result by id
-[**postAndCalculate**](SparCalculationsApi.md#postAndCalculate) | **POST** /analytics/engines/spar/v3/calculations | Create and Run SPAR calculation
-[**putAndCalculate**](SparCalculationsApi.md#putAndCalculate) | **PUT** /analytics/engines/spar/v3/calculations/{id} | Create or Update SPAR calculation and run it.
-
-
-
-## cancelCalculationById
-
-> cancelCalculationById(id)
-
-Cancel SPAR calculation
-
-This is the endpoint to cancel a previously submitted calculation.
-
-### Example
-
-```java
-// Import classes:
-import factset.analyticsapi.engines.ApiClient;
-import factset.analyticsapi.engines.ApiException;
-import factset.analyticsapi.engines.Configuration;
-import factset.analyticsapi.engines.auth.*;
-import factset.analyticsapi.engines.model.*;
-import factset.analyticsapi.engines.api.SparCalculationsApi;
-
-public class Example {
- 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");
-
- SparCalculationsApi apiInstance = new SparCalculationsApi(defaultClient);
- String id = "id_example"; // String | from url, provided from the location header in the Create and Run SPAR calculation endpoint
- try {
- apiInstance.cancelCalculationById(id);
- } catch (ApiException e) {
- System.err.println("Exception when calling SparCalculationsApi#cancelCalculationById");
- System.err.println("Status code: " + e.getCode());
- System.err.println("Reason: " + e.getClientErrorResponse());
- System.err.println("Response headers: " + e.getResponseHeaders());
- e.printStackTrace();
- }
- }
-}
-```
-
-### Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**| from url, provided from the location header in the Create and Run SPAR calculation endpoint |
-
-### Return type
-
-null (empty response body)
-
-### Authorization
-
-[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: text/plain, application/json, text/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **204** | Expected response, calculation was canceled successfully. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **404** | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-
-
-## getAllCalculations
-
-> CalculationsSummaryRoot getAllCalculations(pageNumber)
-
-Get all calculations
-
-This endpoints returns all calculation requests.
-
-### Example
-
-```java
-// Import classes:
-import factset.analyticsapi.engines.ApiClient;
-import factset.analyticsapi.engines.ApiException;
-import factset.analyticsapi.engines.Configuration;
-import factset.analyticsapi.engines.auth.*;
-import factset.analyticsapi.engines.model.*;
-import factset.analyticsapi.engines.api.SparCalculationsApi;
-
-public class Example {
- 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");
-
- SparCalculationsApi apiInstance = new SparCalculationsApi(defaultClient);
- Integer pageNumber = 1; // Integer |
- try {
- CalculationsSummaryRoot result = apiInstance.getAllCalculations(pageNumber);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling SparCalculationsApi#getAllCalculations");
- System.err.println("Status code: " + e.getCode());
- System.err.println("Reason: " + e.getClientErrorResponse());
- System.err.println("Response headers: " + e.getResponseHeaders());
- e.printStackTrace();
- }
- }
-}
-```
-
-### Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **pageNumber** | **Integer**| | [default to 1]
-
-### Return type
-
-[**CalculationsSummaryRoot**](CalculationsSummaryRoot.md)
-
-### Authorization
-
-[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | List of calculation requests. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **400** | Invalid page number. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **404** | No calculation found. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **403** | User is forbidden with current credentials. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **429** | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
-| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-
-
-## getCalculationParameters
-
-> SPARCalculationParametersRoot getCalculationParameters(id)
-
-Get SPAR calculation parameters by id
-
-This is the endpoint that returns the calculation parameters passed for a calculation.
-
-### Example
-
-```java
-// Import classes:
-import factset.analyticsapi.engines.ApiClient;
-import factset.analyticsapi.engines.ApiException;
-import factset.analyticsapi.engines.Configuration;
-import factset.analyticsapi.engines.auth.*;
-import factset.analyticsapi.engines.model.*;
-import factset.analyticsapi.engines.api.SparCalculationsApi;
-
-public class Example {
- 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");
-
- SparCalculationsApi apiInstance = new SparCalculationsApi(defaultClient);
- String id = "id_example"; // String | from url, provided from the location header in the Create and Run SPAR calculation endpoint
- try {
- SPARCalculationParametersRoot result = apiInstance.getCalculationParameters(id);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling SparCalculationsApi#getCalculationParameters");
- System.err.println("Status code: " + e.getCode());
- System.err.println("Reason: " + e.getClientErrorResponse());
- System.err.println("Response headers: " + e.getResponseHeaders());
- e.printStackTrace();
- }
- }
-}
-```
-
-### Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**| from url, provided from the location header in the Create and Run SPAR calculation endpoint |
-
-### Return type
-
-[**SPARCalculationParametersRoot**](SPARCalculationParametersRoot.md)
-
-### Authorization
-
-[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Expected response, returns the SPAR calculation parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header. * Content-Type - Standard HTTP header. * Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **404** | Calculation id not found | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-
-
-## getCalculationStatusById
-
-> CalculationStatusRoot getCalculationStatusById(id)
-
-Get SPAR calculation status by id
-
-This is the endpoint to check on the progress of a previously requested calculation.
-If the calculation has finished computing, the location header will point to the result url.
-
-### Example
-
-```java
-// Import classes:
-import factset.analyticsapi.engines.ApiClient;
-import factset.analyticsapi.engines.ApiException;
-import factset.analyticsapi.engines.Configuration;
-import factset.analyticsapi.engines.auth.*;
-import factset.analyticsapi.engines.model.*;
-import factset.analyticsapi.engines.api.SparCalculationsApi;
-
-public class Example {
- 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");
-
- SparCalculationsApi apiInstance = new SparCalculationsApi(defaultClient);
- String id = "id_example"; // String | from url, provided from the location header in the Create and Run SPAR calculation endpoint
- try {
- CalculationStatusRoot result = apiInstance.getCalculationStatusById(id);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling SparCalculationsApi#getCalculationStatusById");
- System.err.println("Status code: " + e.getCode());
- System.err.println("Reason: " + e.getClientErrorResponse());
- System.err.println("Response headers: " + e.getResponseHeaders());
- e.printStackTrace();
- }
- }
-}
-```
-
-### Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**| from url, provided from the location header in the Create and Run SPAR calculation endpoint |
-
-### Return type
-
-[**CalculationStatusRoot**](CalculationStatusRoot.md)
-
-### Authorization
-
-[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Expected response once calculation is completed. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header. * Content-Type - Standard HTTP header. * Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **202** | Expected response returned if the calculation is not yet completed. | * X-FactSet-Api-PickUp-Progress - FactSet's progress header. * Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-
-
-## getCalculationUnitResultById
-
-> ObjectRoot getCalculationUnitResultById(id, unitId)
-
-Get SPAR calculation result by id
-
-This is the endpoint to get the result of a previously requested calculation.
-If the calculation has finished computing, the body of the response will contain the requested document in JSON.
-
-### Example
-
-```java
-// Import classes:
-import factset.analyticsapi.engines.ApiClient;
-import factset.analyticsapi.engines.ApiException;
-import factset.analyticsapi.engines.Configuration;
-import factset.analyticsapi.engines.auth.*;
-import factset.analyticsapi.engines.model.*;
-import factset.analyticsapi.engines.api.SparCalculationsApi;
-
-public class Example {
- 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");
-
- SparCalculationsApi apiInstance = new SparCalculationsApi(defaultClient);
- String id = "id_example"; // String | from url, provided from the location header in the Get SPAR calculation status by id endpoint
- String unitId = "unitId_example"; // String | from url, provided from the location header in the Get SPAR calculation status by id endpoint
- try {
- ObjectRoot result = apiInstance.getCalculationUnitResultById(id, unitId);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling SparCalculationsApi#getCalculationUnitResultById");
- System.err.println("Status code: " + e.getCode());
- System.err.println("Reason: " + e.getClientErrorResponse());
- System.err.println("Response headers: " + e.getResponseHeaders());
- e.printStackTrace();
- }
- }
-}
-```
-
-### Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**| from url, provided from the location header in the Get SPAR calculation status by id endpoint |
- **unitId** | **String**| from url, provided from the location header in the Get SPAR calculation status by id endpoint |
-
-### Return type
-
-[**ObjectRoot**](ObjectRoot.md)
-
-### Authorization
-
-[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json, application/x-protobuf
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header. * Content-Type - Standard HTTP header. * Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **400** | Invalid identifier provided. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **404** | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-
-
-## postAndCalculate
-
-> CalculationStatusRoot postAndCalculate(xFactSetApiLongRunningDeadline, cacheControl, spARCalculationParametersRoot)
-
-Create and Run SPAR calculation
-
-This endpoint runs the SPAR calculation specified in the POST body parameters.
-It can take one or more units as input.
-
-Remarks:
-
-* Any settings in POST body will act as a one-time override over the settings saved in the SPAR template.
-
-### Example
-
-```java
-// Import classes:
-import factset.analyticsapi.engines.ApiClient;
-import factset.analyticsapi.engines.ApiException;
-import factset.analyticsapi.engines.Configuration;
-import factset.analyticsapi.engines.auth.*;
-import factset.analyticsapi.engines.model.*;
-import factset.analyticsapi.engines.api.SparCalculationsApi;
-
-public class Example {
- 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");
-
- SparCalculationsApi apiInstance = new SparCalculationsApi(defaultClient);
- Integer xFactSetApiLongRunningDeadline = 56; // Integer | Long running deadline in seconds when only one unit is passed in the POST body.
- String cacheControl = "cacheControl_example"; // String | Standard HTTP header. Accepts max-stale.
- SPARCalculationParametersRoot spARCalculationParametersRoot = new SPARCalculationParametersRoot(); // SPARCalculationParametersRoot | Calculation Parameters
- try {
- Object result = apiInstance.postAndCalculate(xFactSetApiLongRunningDeadline, cacheControl, spARCalculationParametersRoot);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling SparCalculationsApi#postAndCalculate");
- System.err.println("Status code: " + e.getCode());
- System.err.println("Reason: " + e.getClientErrorResponse());
- System.err.println("Response headers: " + e.getResponseHeaders());
- e.printStackTrace();
- }
- }
-}
-```
-
-### Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds when only one unit is passed in the POST body. | [optional]
- **cacheControl** | **String**| Standard HTTP header. Accepts max-stale. | [optional]
- **spARCalculationParametersRoot** | [**SPARCalculationParametersRoot**](SPARCalculationParametersRoot.md)| Calculation Parameters | [optional]
-
-### Return type
-
-(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))
-
-### Authorization
-
-[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json, application/x-protobuf
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **200** | Expected response, if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **400** | Invalid calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
-| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-
-
-## putAndCalculate
-
-> CalculationStatusRoot putAndCalculate(id, xFactSetApiLongRunningDeadline, cacheControl, spARCalculationParametersRoot)
-
-Create or Update SPAR calculation and run it.
-
-This endpoint updates and run the SPAR calculation specified in the PUT body parameters. This also allows creating new SPAR calculations with custom ids.
-It can take one or more units as input.
-
-Remarks:
-
-* Any settings in PUT body will act as a one-time override over the settings saved in the SPAR template.
-
-### Example
-
-```java
-// Import classes:
-import factset.analyticsapi.engines.ApiClient;
-import factset.analyticsapi.engines.ApiException;
-import factset.analyticsapi.engines.Configuration;
-import factset.analyticsapi.engines.auth.*;
-import factset.analyticsapi.engines.model.*;
-import factset.analyticsapi.engines.api.SparCalculationsApi;
-
-public class Example {
- 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");
-
- SparCalculationsApi apiInstance = new SparCalculationsApi(defaultClient);
- String id = "id_example"; // String | from url, provided from the location header in the Create and Run SPAR calculation endpoint
- Integer xFactSetApiLongRunningDeadline = 56; // Integer | Long running deadline in seconds when only one unit is passed in the PUT body.
- String cacheControl = "cacheControl_example"; // String | Standard HTTP header. Accepts max-stale.
- SPARCalculationParametersRoot spARCalculationParametersRoot = new SPARCalculationParametersRoot(); // SPARCalculationParametersRoot | Calculation Parameters
- try {
- Object result = apiInstance.putAndCalculate(id, xFactSetApiLongRunningDeadline, cacheControl, spARCalculationParametersRoot);
- System.out.println(result);
- } catch (ApiException e) {
- System.err.println("Exception when calling SparCalculationsApi#putAndCalculate");
- System.err.println("Status code: " + e.getCode());
- System.err.println("Reason: " + e.getClientErrorResponse());
- System.err.println("Response headers: " + e.getResponseHeaders());
- e.printStackTrace();
- }
- }
-}
-```
-
-### Parameters
-
-
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**| from url, provided from the location header in the Create and Run SPAR calculation endpoint |
- **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds when only one unit is passed in the PUT body. | [optional]
- **cacheControl** | **String**| Standard HTTP header. Accepts max-stale. | [optional]
- **spARCalculationParametersRoot** | [**SPARCalculationParametersRoot**](SPARCalculationParametersRoot.md)| Calculation Parameters | [optional]
-
-### Return type
-
-(For 202 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 200 status - [**CalculationStatusRoot**](CalculationStatusRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))
-
-### Authorization
-
-[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json, application/x-protobuf
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **202** | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **200** | Expected response, if the calculation has one unit and is completed with an error. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **201** | Expected response if the calculation has one unit and is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **400** | Invalid Calculation Parameters. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **404** | One or more calculation settings were unavailable. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **409** | Duplicate calculation exists with same parameters. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **429** | Rate limit reached. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
-| **500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-| **503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
-
diff --git a/auto-generated-sdk/docs/TemplatedPaComponentsApi.md b/auto-generated-sdk/docs/TemplatedPaComponentsApi.md
index dd7a5219..776cdf24 100644
--- a/auto-generated-sdk/docs/TemplatedPaComponentsApi.md
+++ b/auto-generated-sdk/docs/TemplatedPaComponentsApi.md
@@ -143,7 +143,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient);
- String id = "id_example"; // String | Unique identifier for a templated PA component
+ String id = "01234567890123456789012345678901"; // String | Unique identifier for a templated PA component
try {
apiInstance.deleteTemplatedPAComponents(id);
} catch (ApiException e) {
@@ -225,7 +225,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient);
- String id = "id_example"; // String | Unique identifier for a templated PA component
+ String id = "01234567890123456789012345678901"; // String | Unique identifier for a templated PA component
try {
TemplatedPAComponentRoot result = apiInstance.getTemplatedPAComponentById(id);
System.out.println(result);
@@ -308,7 +308,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient);
- String directory = "directory_example"; // String | Get templated PA components in path
+ String directory = "Personal:TemplatedPAComponents/"; // String | Get templated PA components in path
try {
TemplatedPAComponentSummaryRoot result = apiInstance.getTemplatedPAComponentsInPath(directory);
System.out.println(result);
@@ -403,7 +403,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
TemplatedPaComponentsApi apiInstance = new TemplatedPaComponentsApi(defaultClient);
- String id = "id_example"; // String | Unique identifier for a templated PA component
+ String id = "01234567890123456789012345678901"; // String | Unique identifier for a templated PA component
TemplatedPAComponentUpdateParametersRoot templatedPAComponentUpdateParametersRoot = new TemplatedPAComponentUpdateParametersRoot(); // TemplatedPAComponentUpdateParametersRoot | Request Parameters
try {
TemplatedPAComponentPostSummaryRoot result = apiInstance.updateTemplatedPAComponents(id, templatedPAComponentUpdateParametersRoot);
diff --git a/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md b/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md
index 330700cb..d23595b2 100644
--- a/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md
+++ b/auto-generated-sdk/docs/UnlinkedPaTemplatesApi.md
@@ -153,7 +153,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient);
- String id = "id_example"; // String | Unique identifier for an unlinked PA template
+ String id = "01234567890123456789012345678901"; // String | Unique identifier for an unlinked PA template
try {
apiInstance.deleteUnlinkedPATemplates(id);
} catch (ApiException e) {
@@ -395,8 +395,8 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient);
- String directory = "directory_example"; // String | Get unlinked PA templates in path.
- String category = "category_example"; // String | Get unlinked PA templates by category.
+ String directory = "Personal:UninkedPATemplates/"; // String | Get unlinked PA templates in path.
+ String category = "Weights"; // String | Get unlinked PA templates by category.
try {
UnlinkedPATemplateSummaryRoot result = apiInstance.getUnlinkedPATemplates(directory, category);
System.out.println(result);
@@ -479,7 +479,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient);
- String id = "id_example"; // String | Unique identifier for an unlinked PA template
+ String id = "01234567890123456789012345678901"; // String | Unique identifier for an unlinked PA template
try {
UnlinkedPATemplateRoot result = apiInstance.getUnlinkedPATemplatesById(id);
System.out.println(result);
@@ -584,7 +584,7 @@ public class Example {
Bearer.setBearerToken("BEARER TOKEN");
UnlinkedPaTemplatesApi apiInstance = new UnlinkedPaTemplatesApi(defaultClient);
- String id = "id_example"; // String | Unique identifier for an unlinked PA template
+ String id = "01234567890123456789012345678901"; // String | Unique identifier for an unlinked PA template
UnlinkedPATemplateUpdateParametersRoot unlinkedPATemplateUpdateParametersRoot = new UnlinkedPATemplateUpdateParametersRoot(); // UnlinkedPATemplateUpdateParametersRoot | Request Parameters
try {
UnlinkedPATemplatePostSummaryRoot result = apiInstance.updateUnlinkedPATemplates(id, unlinkedPATemplateUpdateParametersRoot);
diff --git a/auto-generated-sdk/docs/BenchmarksApi.md b/auto-generated-sdk/docs/VaultAttributionLoaderApi.md
similarity index 70%
rename from auto-generated-sdk/docs/BenchmarksApi.md
rename to auto-generated-sdk/docs/VaultAttributionLoaderApi.md
index 21a53a18..9d588e13 100644
--- a/auto-generated-sdk/docs/BenchmarksApi.md
+++ b/auto-generated-sdk/docs/VaultAttributionLoaderApi.md
@@ -1,32 +1,33 @@
-# BenchmarksApi
+# VaultAttributionLoaderApi
All URIs are relative to *https://api.factset.com*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**getSPARBenchmarkById**](BenchmarksApi.md#getSPARBenchmarkById) | **GET** /analytics/engines/spar/v3/benchmarks | Get SPAR benchmark details
+[**vaultAttributionLoader**](VaultAttributionLoaderApi.md#vaultAttributionLoader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader
-## getSPARBenchmarkById
+## vaultAttributionLoader
-> SPARBenchmarkRoot getSPARBenchmarkById(id)
+> VaultAttributionLoaderResponseRoot vaultAttributionLoader(batchId, file)
-Get SPAR benchmark details
+Vault - External Attribution Loader
-This endpoint returns the details of a given SPAR benchmark identifier.
+This endpoint loads Vault External Attributions.
### Example
```java
+import java.io.File;
// Import classes:
import factset.analyticsapi.engines.ApiClient;
import factset.analyticsapi.engines.ApiException;
import factset.analyticsapi.engines.Configuration;
import factset.analyticsapi.engines.auth.*;
import factset.analyticsapi.engines.model.*;
-import factset.analyticsapi.engines.api.BenchmarksApi;
+import factset.analyticsapi.engines.api.VaultAttributionLoaderApi;
public class Example {
public static void main(String[] args) {
@@ -42,13 +43,14 @@ public class Example {
HttpBearerAuth Bearer = (HttpBearerAuth) defaultClient.getAuthentication("Bearer");
Bearer.setBearerToken("BEARER TOKEN");
- BenchmarksApi apiInstance = new BenchmarksApi(defaultClient);
- String id = "id_example"; // String | Benchmark Identifier
+ VaultAttributionLoaderApi apiInstance = new VaultAttributionLoaderApi(defaultClient);
+ String batchId = "batchId_example"; // String |
+ File file = new File("/path/to/file"); // File |
try {
- SPARBenchmarkRoot result = apiInstance.getSPARBenchmarkById(id);
+ VaultAttributionLoaderResponseRoot result = apiInstance.vaultAttributionLoader(batchId, file);
System.out.println(result);
} catch (ApiException e) {
- System.err.println("Exception when calling BenchmarksApi#getSPARBenchmarkById");
+ System.err.println("Exception when calling VaultAttributionLoaderApi#vaultAttributionLoader");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getClientErrorResponse());
System.err.println("Response headers: " + e.getResponseHeaders());
@@ -63,11 +65,12 @@ public class Example {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id** | **String**| Benchmark Identifier |
+ **batchId** | **String**| |
+ **file** | **File**| | [optional]
### Return type
-[**SPARBenchmarkRoot**](SPARBenchmarkRoot.md)
+[**VaultAttributionLoaderResponseRoot**](VaultAttributionLoaderResponseRoot.md)
### Authorization
@@ -75,15 +78,14 @@ Name | Type | Description | Notes
### HTTP request headers
-- **Content-Type**: Not defined
+- **Content-Type**: multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-| **200** | Expected response, returns the list of prefix and return types for the benchmark. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **400** | Invalid benchmark identifier. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
-| **404** | Benchmark identifier not found. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **200** | Expected response, returns a status of operation along with errors and warnings if found any. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
+| **400** | Bad Request | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| **401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. |
| **403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| **406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
diff --git a/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md b/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md
new file mode 100644
index 00000000..c4889bd9
--- /dev/null
+++ b/auto-generated-sdk/docs/VaultAttributionLoaderResponse.md
@@ -0,0 +1,19 @@
+
+
+# VaultAttributionLoaderResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**processId** | **String** | ProcessId. | [optional]
+**groupId** | **String** | GroupId. | [optional]
+**objectId** | **String** | ObjectId. | [optional]
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md b/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md
new file mode 100644
index 00000000..5cc5749f
--- /dev/null
+++ b/auto-generated-sdk/docs/VaultAttributionLoaderResponseRoot.md
@@ -0,0 +1,18 @@
+
+
+# VaultAttributionLoaderResponseRoot
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**VaultAttributionLoaderResponse**](VaultAttributionLoaderResponse.md) | |
+**meta** | **Object** | | [optional]
+
+
+## Implemented Interfaces
+
+* Serializable
+
+
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiException.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiException.java
index b2350f22..adc8baca 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiException.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiException.java
@@ -3,7 +3,7 @@
* Engines API
* Allow clients to fetch Analytics through APIs.
*
- * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
+ * The version of the OpenAPI document: v3:[pa,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,security-modeling,others],v1:[fiab]
* Contact: api@factset.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiResponse.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiResponse.java
index 7fc143e8..b1da4cdc 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiResponse.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/ApiResponse.java
@@ -2,7 +2,7 @@
* Engines API
* Allow clients to fetch Analytics through APIs.
*
- * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
+ * The version of the OpenAPI document: v3:[pa,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,security-modeling,others],v1:[fiab]
* Contact: api@factset.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/Configuration.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/Configuration.java
index 3bb157a4..04c50ec5 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/Configuration.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/Configuration.java
@@ -2,7 +2,7 @@
* Engines API
* Allow clients to fetch Analytics through APIs.
*
- * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
+ * The version of the OpenAPI document: v3:[pa,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,security-modeling,others],v1:[fiab]
* Contact: api@factset.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/JavaTimeFormatter.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/JavaTimeFormatter.java
index 5c08ad55..0e743110 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/JavaTimeFormatter.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/JavaTimeFormatter.java
@@ -2,7 +2,7 @@
* Engines API
* Allow clients to fetch Analytics through APIs.
*
- * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
+ * The version of the OpenAPI document: v3:[pa,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,security-modeling,others],v1:[fiab]
* Contact: api@factset.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/Pair.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/Pair.java
index 5a57d4a1..39884077 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/Pair.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/Pair.java
@@ -2,7 +2,7 @@
* Engines API
* Allow clients to fetch Analytics through APIs.
*
- * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
+ * The version of the OpenAPI document: v3:[pa,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,security-modeling,others],v1:[fiab]
* Contact: api@factset.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/RFC3339DateFormat.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/RFC3339DateFormat.java
index bee88623..bed2d729 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/RFC3339DateFormat.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/RFC3339DateFormat.java
@@ -2,7 +2,7 @@
* Engines API
* Allow clients to fetch Analytics through APIs.
*
- * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
+ * The version of the OpenAPI document: v3:[pa,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,security-modeling,others],v1:[fiab]
* Contact: api@factset.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/StringUtil.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/StringUtil.java
index dd40c3b3..c6eccfc6 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/StringUtil.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/StringUtil.java
@@ -2,7 +2,7 @@
* Engines API
* Allow clients to fetch Analytics through APIs.
*
- * The version of the OpenAPI document: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
+ * The version of the OpenAPI document: v3:[pa,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,security-modeling,others],v1:[fiab]
* Contact: api@factset.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AccountsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AccountsApi.java
index 3d875056..a34227eb 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AccountsApi.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/AccountsApi.java
@@ -16,7 +16,6 @@
import factset.analyticsapi.engines.models.AccountDirectoriesRoot;
import factset.analyticsapi.engines.models.ClientErrorResponse;
-import factset.analyticsapi.engines.models.SPARAccountsRoot;
@javax.annotation.Generated(value = "CustomJavaClientCodegen")
public class AccountsApi {
@@ -50,7 +49,7 @@ public void setApiClient(ApiClient apiClient) {
/**
* Get accounts and sub-directories in a directory
* This endpoint looks up all ACCT and ACTM files and sub-directories in a given directory.
- * @param path The directory to get the accounts and sub-directories in (required)
+ * @param path The directory to get the accounts and sub-directories. (required)
@return AccountDirectoriesRoot
* @throws ApiException if fails to make API call
* @http.response.details
@@ -74,7 +73,7 @@ public AccountDirectoriesRoot getAccounts(String path) throws ApiException {
/**
* Get accounts and sub-directories in a directory
* This endpoint looks up all ACCT and ACTM files and sub-directories in a given directory.
- * @param path The directory to get the accounts and sub-directories in (required)
+ * @param path The directory to get the accounts and sub-directories. (required)
* @return ApiResponse<AccountDirectoriesRoot>
* @throws ApiException if fails to make API call
* @http.response.details
@@ -136,93 +135,4 @@ public ApiResponse getAccountsWithHttpInfo(String path)
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, returnTypeMap, false);
}
- /**
- * Get SPAR account returns type details
- * This endpoint returns the returns type of account associated with SPAR
- * @param accountPath URL encoded account path (required)
- @return SPARAccountsRoot
- * @throws ApiException if fails to make API call
- * @http.response.details
-
-
Status Code
Description
Response Headers
-
200
Expected response, returns the list of return types for the account.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
400
Invalid account.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
404
Account not found.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
401
Missing or invalid authentication.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
403
User is forbidden with current credentials
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
406
Unsupported Accept header. Header needs to be set to application/json.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
429
Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
-
500
Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
503
Request timed out. Retry the request in sometime.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
- */
- public SPARAccountsRoot getSPARReturnsType(String accountPath) throws ApiException {
- return getSPARReturnsTypeWithHttpInfo(accountPath).getData();
- }
-
- /**
- * Get SPAR account returns type details
- * This endpoint returns the returns type of account associated with SPAR
- * @param accountPath URL encoded account path (required)
- * @return ApiResponse<SPARAccountsRoot>
- * @throws ApiException if fails to make API call
- * @http.response.details
-
-
Status Code
Description
Response Headers
-
200
Expected response, returns the list of return types for the account.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
400
Invalid account.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
404
Account not found.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
401
Missing or invalid authentication.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
403
User is forbidden with current credentials
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
406
Unsupported Accept header. Header needs to be set to application/json.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
429
Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
-
500
Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
503
Request timed out. Retry the request in sometime.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
- */
- public ApiResponse getSPARReturnsTypeWithHttpInfo(String accountPath) throws ApiException {
- Object localVarPostBody = null;
-
- // verify the required parameter 'accountPath' is set
- if (accountPath == null) {
- throw new ApiException(400, "Missing the required parameter 'accountPath' when calling getSPARReturnsType");
- }
-
- // create path and map variables
- String localVarPath = "/analytics/engines/spar/v3/accounts/{accountPath}/returns-type"
- .replaceAll("\\{" + "accountPath" + "\\}", apiClient.escapeString(accountPath.toString()));
-
- // query params
- java.util.List localVarQueryParams = new java.util.ArrayList();
- java.util.Map localVarHeaderParams = new java.util.HashMap();
- java.util.Map localVarCookieParams = new java.util.HashMap();
- java.util.Map localVarFormParams = new java.util.HashMap();
-
-
-
-
-
- final String[] localVarAccepts = {
- "application/json"
- };
- final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
-
- final String[] localVarContentTypes = {
-
- };
- final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
-
- String[] localVarAuthNames = new String[] { "Basic", "Bearer" };
-
- GenericType localVarReturnType = new GenericType() {};
-
- Map returnTypeMap = new HashMap();
- returnTypeMap.put(200, new GenericType(){});
- returnTypeMap.put(400, new GenericType(){});
- returnTypeMap.put(404, new GenericType(){});
-
- return apiClient.invokeAPIWithReturnMap("AccountsApi.getSPARReturnsType", localVarPath, "GET", localVarQueryParams, localVarPostBody,
- localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
- localVarAuthNames, returnTypeMap, false);
- }
}
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ComponentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ComponentsApi.java
index acc63f18..707d788d 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ComponentsApi.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/ComponentsApi.java
@@ -226,95 +226,6 @@ public ApiResponse getPAComponentsWithHttpInfo(String docu
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, returnTypeMap, false);
}
- /**
- * Get SPAR components
- * This endpoint returns the list of SPAR components in a given SPAR document.
- * @param document Document Name (required)
- @return ComponentSummaryRoot
- * @throws ApiException if fails to make API call
- * @http.response.details
-
-
Status Code
Description
Response Headers
-
200
Expected response, returns a list of SPAR components.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
400
Invalid query parameter provided or Invalid SPAR document name.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
404
SPAR Document not found.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
401
Missing or invalid authentication.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
403
User is forbidden with current credentials
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
406
Unsupported Accept header. Header needs to be set to application/json.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
429
Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
-
500
Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
503
Request timed out. Retry the request in sometime.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
- */
- public ComponentSummaryRoot getSPARComponents(String document) throws ApiException {
- return getSPARComponentsWithHttpInfo(document).getData();
- }
-
- /**
- * Get SPAR components
- * This endpoint returns the list of SPAR components in a given SPAR document.
- * @param document Document Name (required)
- * @return ApiResponse<ComponentSummaryRoot>
- * @throws ApiException if fails to make API call
- * @http.response.details
-
-
Status Code
Description
Response Headers
-
200
Expected response, returns a list of SPAR components.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
400
Invalid query parameter provided or Invalid SPAR document name.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
404
SPAR Document not found.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
401
Missing or invalid authentication.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
403
User is forbidden with current credentials
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
406
Unsupported Accept header. Header needs to be set to application/json.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
429
Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
-
500
Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
503
Request timed out. Retry the request in sometime.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
- */
- public ApiResponse getSPARComponentsWithHttpInfo(String document) throws ApiException {
- Object localVarPostBody = null;
-
- // verify the required parameter 'document' is set
- if (document == null) {
- throw new ApiException(400, "Missing the required parameter 'document' when calling getSPARComponents");
- }
-
- // create path and map variables
- String localVarPath = "/analytics/engines/spar/v3/components";
-
- // query params
- java.util.List localVarQueryParams = new java.util.ArrayList();
- java.util.Map localVarHeaderParams = new java.util.HashMap();
- java.util.Map localVarCookieParams = new java.util.HashMap();
- java.util.Map localVarFormParams = new java.util.HashMap();
-
- localVarQueryParams.addAll(apiClient.parameterToPairs("", "document", document));
-
-
-
-
- final String[] localVarAccepts = {
- "application/json"
- };
- final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
-
- final String[] localVarContentTypes = {
-
- };
- final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
-
- String[] localVarAuthNames = new String[] { "Basic", "Bearer" };
-
- GenericType localVarReturnType = new GenericType() {};
-
- Map returnTypeMap = new HashMap();
- returnTypeMap.put(200, new GenericType(){});
- returnTypeMap.put(400, new GenericType(){});
- returnTypeMap.put(404, new GenericType(){});
-
- return apiClient.invokeAPIWithReturnMap("ComponentsApi.getSPARComponents", localVarPath, "GET", localVarQueryParams, localVarPostBody,
- localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
- localVarAuthNames, returnTypeMap, false);
- }
/**
* Get Vault component by id
* This endpoint returns the default settings of a Vault component.
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DatesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DatesApi.java
index 305149cc..b9fc5f59 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DatesApi.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DatesApi.java
@@ -51,7 +51,7 @@ public void setApiClient(ApiClient apiClient) {
* This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a PA calculation. For more information on FactSet date format, please refer to the PA Engine API documentation under the 'API Documentation' section in the developer portal.
* @param enddate End Date (required)
* @param componentid Component Id (required)
- * @param account Account (required)
+ * @param account Account ( Should be in Format - AccountName.ACCT ) (required)
* @param startdate Start Date (optional)
@return DateParametersSummaryRoot
* @throws ApiException if fails to make API call
@@ -78,7 +78,7 @@ public DateParametersSummaryRoot convertPADatesToAbsoluteFormat(String enddate,
* This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a PA calculation. For more information on FactSet date format, please refer to the PA Engine API documentation under the 'API Documentation' section in the developer portal.
* @param enddate End Date (required)
* @param componentid Component Id (required)
- * @param account Account (required)
+ * @param account Account ( Should be in Format - AccountName.ACCT ) (required)
* @param startdate Start Date (optional)
* @return ApiResponse<DateParametersSummaryRoot>
* @throws ApiException if fails to make API call
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DocumentsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DocumentsApi.java
index f40f73bb..022f82b9 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DocumentsApi.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/DocumentsApi.java
@@ -224,95 +224,6 @@ public ApiResponse getPubDocumentsWithHttpInfo(String p
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, returnTypeMap, false);
}
- /**
- * Gets SPAR3 documents and sub-directories in a directory
- * This endpoint looks up all SPAR3 documents and sub-directories in a given directory.
- * @param path The directory to get the documents in (required)
- @return DocumentDirectoriesRoot
- * @throws ApiException if fails to make API call
- * @http.response.details
-
-
Status Code
Description
Response Headers
-
200
Expected response, returns a list of SPAR3 documents and directories
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
400
Invalid query parameter or value provided
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
404
Path not found
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
401
Missing or invalid authentication
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
403
User is forbidden with current credentials
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
406
Unsupported Accept header. Header needs to be set to application/json
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
429
Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
-
500
Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
503
Request timed out. Retry the request in some time
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
- */
- public DocumentDirectoriesRoot getSPAR3Documents(String path) throws ApiException {
- return getSPAR3DocumentsWithHttpInfo(path).getData();
- }
-
- /**
- * Gets SPAR3 documents and sub-directories in a directory
- * This endpoint looks up all SPAR3 documents and sub-directories in a given directory.
- * @param path The directory to get the documents in (required)
- * @return ApiResponse<DocumentDirectoriesRoot>
- * @throws ApiException if fails to make API call
- * @http.response.details
-
-
Status Code
Description
Response Headers
-
200
Expected response, returns a list of SPAR3 documents and directories
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
400
Invalid query parameter or value provided
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
404
Path not found
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
401
Missing or invalid authentication
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
403
User is forbidden with current credentials
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
406
Unsupported Accept header. Header needs to be set to application/json
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
429
Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
-
500
Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
503
Request timed out. Retry the request in some time
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
- */
- public ApiResponse getSPAR3DocumentsWithHttpInfo(String path) throws ApiException {
- Object localVarPostBody = null;
-
- // verify the required parameter 'path' is set
- if (path == null) {
- throw new ApiException(400, "Missing the required parameter 'path' when calling getSPAR3Documents");
- }
-
- // create path and map variables
- String localVarPath = "/analytics/engines/spar/v3/documents/{path}"
- .replaceAll("\\{" + "path" + "\\}", apiClient.escapeString(path.toString()));
-
- // query params
- java.util.List localVarQueryParams = new java.util.ArrayList();
- java.util.Map localVarHeaderParams = new java.util.HashMap();
- java.util.Map localVarCookieParams = new java.util.HashMap();
- java.util.Map localVarFormParams = new java.util.HashMap();
-
-
-
-
-
- final String[] localVarAccepts = {
- "application/json"
- };
- final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
-
- final String[] localVarContentTypes = {
-
- };
- final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
-
- String[] localVarAuthNames = new String[] { "Basic", "Bearer" };
-
- GenericType localVarReturnType = new GenericType() {};
-
- Map returnTypeMap = new HashMap();
- returnTypeMap.put(200, new GenericType(){});
- returnTypeMap.put(400, new GenericType(){});
- returnTypeMap.put(404, new GenericType(){});
-
- return apiClient.invokeAPIWithReturnMap("DocumentsApi.getSPAR3Documents", localVarPath, "GET", localVarQueryParams, localVarPostBody,
- localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
- localVarAuthNames, returnTypeMap, false);
- }
/**
* Get Vault documents and sub-directories in a directory
* This endpoint looks up all Vault documents and sub-directories in a given directory.
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FrequenciesApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FrequenciesApi.java
index b19aa140..6ba81c96 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FrequenciesApi.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/FrequenciesApi.java
@@ -120,81 +120,6 @@ public ApiResponse getPAFrequenciesWithHttpInfo() throws ApiExcep
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, returnTypeMap, false);
}
- /**
- * Get SPAR frequencies
- * This endpoint lists all the frequencies that can be applied to a SPAR calculation.
- @return FrequencyRoot
- * @throws ApiException if fails to make API call
- * @http.response.details
-
-
Status Code
Description
Response Headers
-
200
Expected response, returns a list of SPAR frequencies.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
401
Missing or invalid authentication.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
403
User is forbidden with current credentials
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
406
Unsupported Accept header. Header needs to be set to application/json.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
429
Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
-
500
Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
503
Request timed out. Retry the request in sometime.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
- */
- public FrequencyRoot getSPARFrequencies() throws ApiException {
- return getSPARFrequenciesWithHttpInfo().getData();
- }
-
- /**
- * Get SPAR frequencies
- * This endpoint lists all the frequencies that can be applied to a SPAR calculation.
- * @return ApiResponse<FrequencyRoot>
- * @throws ApiException if fails to make API call
- * @http.response.details
-
-
Status Code
Description
Response Headers
-
200
Expected response, returns a list of SPAR frequencies.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
401
Missing or invalid authentication.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
403
User is forbidden with current credentials
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
406
Unsupported Accept header. Header needs to be set to application/json.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
-
429
Rate limit reached. Wait till the time specified in Retry-After header value to make further requests.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
-
500
Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
503
Request timed out. Retry the request in sometime.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
-
- */
- public ApiResponse getSPARFrequenciesWithHttpInfo() throws ApiException {
- Object localVarPostBody = null;
-
- // create path and map variables
- String localVarPath = "/analytics/engines/spar/v3/frequencies";
-
- // query params
- java.util.List localVarQueryParams = new java.util.ArrayList();
- java.util.Map localVarHeaderParams = new java.util.HashMap();
- java.util.Map localVarCookieParams = new java.util.HashMap();
- java.util.Map localVarFormParams = new java.util.HashMap();
-
-
-
-
-
- final String[] localVarAccepts = {
- "application/json"
- };
- final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
-
- final String[] localVarContentTypes = {
-
- };
- final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
-
- String[] localVarAuthNames = new String[] { "Basic", "Bearer" };
-
- GenericType localVarReturnType = new GenericType() {};
-
- Map returnTypeMap = new HashMap();
- returnTypeMap.put(200, new GenericType(){});
-
- return apiClient.invokeAPIWithReturnMap("FrequenciesApi.getSPARFrequencies", localVarPath, "GET", localVarQueryParams, localVarPostBody,
- localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
- localVarAuthNames, returnTypeMap, false);
- }
/**
* Get Vault frequencies
* This endpoint lists all the frequencies that can be applied to a Vault calculation.
diff --git a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/QuantCalculationsApi.java b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/QuantCalculationsApi.java
index 3bbd19ff..ecb67715 100644
--- a/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/QuantCalculationsApi.java
+++ b/auto-generated-sdk/src/main/java/factset/analyticsapi/engines/api/QuantCalculationsApi.java
@@ -594,6 +594,7 @@ public ApiResponse getCalculationUnitResultByIdWithHttpInfo(String id, Str
200
Expected response if the calculation has one unit and is completed with an error.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
400
Invalid calculation parameters.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
404
One or more calculation settings were unavailable.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
+
413
Request body too large
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
401
Missing or invalid authentication.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
403
User is forbidden with current credentials
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
415
Missing/Invalid Content-Type header. Header needs to be set to application/json.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
@@ -621,6 +622,7 @@ public Object postAndCalculate(String cacheControl, QuantCalculationParametersRo
200
Expected response if the calculation has one unit and is completed with an error.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
400
Invalid calculation parameters.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
404
One or more calculation settings were unavailable.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
+
413
Request body too large
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
401
Missing or invalid authentication.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
403
User is forbidden with current credentials
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
415
Missing/Invalid Content-Type header. Header needs to be set to application/json.
* X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.